KnowledgeArticles

Upsert multiple articles

Upsert an array of knowledge articles This endpoint will create or update articles based on the unique `id` field of each article. If an article with the same `id` already exists, it will be updated. Otherwise, a new article will be created. **Limits:** - The maximum size of a request payload is 10MB - The maximum size of an article is 100KB - The maximum number of articles is 50,000

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects a list of objects.
idstringRequired>=1 character<=160 characters
A unique identifier for the article
namestringRequired>=1 character<=255 characters
The name or title of the article
contentstringRequired>=1 character
The content of the article in markdown format
knowledge_source_idstringRequired

The id of the knowledge_source the article belongs to

urlstring or nullOptionalformat: "url"
The url of the article
tag_idslist of stringsOptional
A list of ids for the tags associated with the article
languagestringOptional

The IETF BCP 47 language code for the article, defaults to en

external_createdstring or nullOptionalformat: "date-time"
The date the article was created in the source system
external_updatedstring or nullOptionalformat: "date-time"
The date the article was last updated in the source system
enabledbooleanOptional

Whether the article should be referenced during response generation, defaults to true

metadataobject or nullOptional
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.

Response

Articles upserted
idstring>=1 character<=160 characters
A unique identifier for the article
successboolean or null

Whether the article was successfully created/updated

createdboolean or null

True if a new article was created, false if an existing article was updated

Errors