Upsert multiple articles — Ada

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 100,000

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

urlstringOptional

The url of the article

tag_idslist of stringsOptional

A list of ids for the tags associated with the article

localestringOptional

The IETF BCP 47 language code for the article, defaults to en or to the value of language if provided

languagestringOptional

The ISO 639-1 language code of the article, defaults to en or is derived from the value of locale if provided

external_createddatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date the article was created in the source system

external_updateddatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date the article was last updated in the source system

enabledbooleanOptionalDefaults to false

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

metadatamap from strings to anyOptional

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

successbooleanOptionalDefaults to false

Whether the article was successfully created/updated

createdbooleanOptionalDefaults to false

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

1	import requests
2
3	url = "https://example.ada.support/api/v2/knowledge/bulk/articles/"
4
5	payload = [
6	{
7	"id": "5df263b7db5a7e6ea03fae9b",
8	"name": "How to reset your password",
9	"content": "# How to reset your password\n\n1. Go to the login page\n2. Click on the \"Forgot password\" link\n3. Follow the instructions",
10	"knowledge_source_id": "5df263b7db5a7e6ea03fae9b"
11	}
12	]
13	headers = {
14	"Authorization": "Bearer <apiKey>",
15	"Content-Type": "application/json"
16	}
17
18	response = requests.post(url, json=payload, headers=headers)
19
20	print(response.json())

1	[
2	{
3	"id": "5df263b7db5a7e6ea03fae9b",
4	"success": true,
5	"created": true
6	}
7	]