Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ada subpackage_knowledge.subpackage_knowledge/articles API

The subpackage_knowledge.subpackage_knowledge/articles API from Ada — 3 operation(s) for subpackage_knowledge.subpackage_knowledge/articles.

Ada subpackage_knowledge.subpackage_knowledge/articles API is one of 13 APIs that Ada publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include subpackage_knowledge.subpackage_knowledge/articles. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 5 base URLs: https://example.ada.support, https://example.att.ada.support, https://example.maple.ada.support, https://example.ficanex.ada.support, https://example.eu.ada.support.

5 operations 3 paths 12 schemas 2 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ada.cx
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Ada subpackage_knowledge.subpackage_knowledge/articles API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_knowledge.subpackage_knowledge/articles 5
GET
/v2/knowledge/articles/
Get knowledge articles
list 8 params → 200400401404429500
DELETE
/v2/knowledge/articles/
Delete multiple articles
delete 6 params → 204400401404429500
GET
/v2/knowledge/articles/{id}
Get a single knowledge article
get 2 params → 200401404429500
DELETE
/v2/knowledge/articles/{id}
Delete a single article
delete-by-id 2 params → 204400401404429500
POST
/v2/knowledge/bulk/articles/
Upsert multiple articles
bulk-upsert 1 param body → 200400401429500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are KnowledgeArticleResponse (13 properties), KnowledgeArticleUpsertRequest (11 properties), KnowledgeArticleUpsertResponse (3 properties), ErrorsErrorsItems (3 properties). Each schema is shown below with its type and property counts.

knowledge_articles_list_Response_200
object
2 properties
PaginationMetadata
object
1 property
knowledge_articles_delete_Response_204
object
Empty response body
KnowledgeArticleUpsertResponse
object
3 properties 1 required
KnowledgeArticleUpsertRequestMetadata
object
A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the article.
KnowledgeArticleUpsertRequest
object
11 properties 4 required
knowledge_articles_deleteById_Response_204
object
Empty response body
KnowledgeArticleResponse
object
13 properties 3 required
ArticleLanguage
string
The ISO 639-1 language code of the article, defaults to en
Errors
object
1 property 1 required
ErrorsErrorsItems
object
3 properties 2 required
KnowledgeArticleResponseMetadata
object
A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the article.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ada-subpackage-knowledge-subpackage-knowledge-articles-api-openapi.yml Raw ↑

Other APIs Ada publishes across the network.

Ada End Users API
Ada Conversations API
Ada Integrations API
Ada subpackage_channels API
Ada subpackage_conversations API
Ada subpackage_deleteChatterData API
Ada subpackage_endUsers API
Ada subpackage_knowledge.subpackage_knowledge/sources API
Ada subpackage_knowledge.subpackage_knowledge/tags API
Ada subpackage_messages API
Ada subpackage_platformIntegrations API
Ada subpackage_webhookManagement API