Get a single knowledge article — Ada

Get knowledge article by id

Path parameters

idstringRequired

The id of the article to retrieve

Response

Knowledge article

idstring>=1 character<=160 characters

A unique identifier for the article

namestring>=1 character<=255 characters

The name or title of the article

contentstring>=1 character

The content of the article in markdown format

urlstringOptional

The url of the article

knowledge_source_idstringOptional

The id of the knowledge_source the article belongs to

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

tag_idslist of stringsOptional

A list of ids for the tags associated with the article

createddatetimeOptional

The date the article was created in Ada

updateddatetimeOptional

The date the article was last updated in Ada

external_createddatetimeOptional

The date the article was created in the source system

external_updateddatetimeOptional

The date the article was last updated in the source system

enabledbooleanOptional

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.

1 import requests 2 3 url = "https://example.ada.support/api/v2/knowledge/articles/5df263b7db5a7e6ea03fae9b" 4 5 headers = {"Authorization": "Bearer <apiKey>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "id": "5df263b7db5a7e6ea03fae9b", 3 "name": "How to reset your password", 4 "content": "# How to reset your password\\n\\n1. Go to the login page\\n2. Click on the \"Forgot password\" link\\n3. Follow the instructions", 5 "url": "https://example.com/article", 6 "knowledge_source_id": "5df263b7db5a7e6ea03fae9b", 7 "locale": "en-CA", 8 "language": "en", 9 "tag_ids": [ 10 "5df263b7db5a7e6ea03fae9b", 11 "5df263b7db5a7e6ea03fae9c" 12 ], 13 "created": "2020-09-20T00:00:00Z", 14 "updated": "2020-09-20T00:00:00Z", 15 "external_created": "2020-09-20T00:00:00Z", 16 "external_updated": "2020-09-20T00:00:00Z", 17 "enabled": true, 18 "metadata": { 19 "key": "value" 20 } 21 }

1	import requests
2
3	url = "https://example.ada.support/api/v2/knowledge/articles/5df263b7db5a7e6ea03fae9b"
4
5	headers = {"Authorization": "Bearer <apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": "5df263b7db5a7e6ea03fae9b",
3	"name": "How to reset your password",
4	"content": "# How to reset your password\\n\\n1. Go to the login page\\n2. Click on the \"Forgot password\" link\\n3. Follow the instructions",
5	"url": "https://example.com/article",
6	"knowledge_source_id": "5df263b7db5a7e6ea03fae9b",
7	"locale": "en-CA",
8	"language": "en",
9	"tag_ids": [
10	"5df263b7db5a7e6ea03fae9b",
11	"5df263b7db5a7e6ea03fae9c"
12	],
13	"created": "2020-09-20T00:00:00Z",
14	"updated": "2020-09-20T00:00:00Z",
15	"external_created": "2020-09-20T00:00:00Z",
16	"external_updated": "2020-09-20T00:00:00Z",
17	"enabled": true,
18	"metadata": {
19	"key": "value"
20	}
21	}