KnowledgeArticles

Get a single knowledge article

Get knowledge article by id

Path parameters

idstringRequired
The id of the article to retrieve

Headers

AuthorizationstringRequired

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

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
urlstring or nullformat: "url"
The url of the article
knowledge_source_idstring or null

The id of the knowledge_source the article belongs to

languageenum or null

The ISO 639-1 language code of the article, defaults to en

tag_idslist of strings or null
A list of ids for the tags associated with the article
createdstring or nullformat: "date-time"
The date the article was created in Ada
updatedstring or nullformat: "date-time"
The date the article was last updated in Ada
external_createdstring or nullformat: "date-time"
The date the article was created in the source system
external_updatedstring or nullformat: "date-time"
The date the article was last updated in the source system
enabledboolean or null

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

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

Errors