knowledge > articles

Get a single knowledge article

Get knowledge article by id

get/v2/knowledge/articles/{id}

Request

  • Base URL: https://example.ada.support/api
  • URL: https://example.ada.support/api/v2/knowledge/articles/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The id of the article to retrieve

Response

Knowledge article

idstring required

A unique identifier for the article

namestring required

The name or title of the article

contentstring required

The content of the article in markdown format

urlstring url nullable

The url of the article

knowledge_source_idstring nullable

The id of the knowledge_source the article belongs to

language'ar' | 'zh' | 'zh-tw' | 'da' | 'nl' | 'en' | 'fi' | 'fr' | 'de' | 'he' | 'hi' | 'id' | 'in' | 'it' | 'ja' | 'ko' | 'ms' | 'pt' | 'pa' | 'ru' | 'es' | 'sv' | 'tl' | 'ta' | 'th' | 'tr' | 'vi' | 'ht' | 'my' | 'km' | 'bg' | 'ro' | 'el' | 'hu' | 'pl' | 'cs' | 'et' | 'hr' | 'lt' | 'lv' | 'sl' | 'sk' | 'is' | 'be' | 'uk' | 'ca' | 'sq' | 'bs' | 'sr' | 'kk'

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

tag_idsstring[]

A list of ids for the tags associated with the article

createdstring date-time

The date the article was created in Ada

updatedstring date-time

The date the article was last updated in Ada

external_createdstring date-time nullable

The date the article was created in the source system

external_updatedstring date-time nullable

The date the article was last updated in the source system

enabledboolean

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

metadataKnowledgeArticleResponseMetadata

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.

Changes

No recorded changes to this operation across all 1 revision of this API.