Use the POST method to create and update articles in your knowledge hub.
Pay close attention to the id
property on the article data when using this endpoint. Each article in your knowledge hub needs to have a unique ID.
- When you POST an article to Ada, we will create a new article if no other article has the same ID.
- If an article with that ID already exists, we will update that article with the new data.
If your knowledge base is in a tool like Zendesk or Salesforce that automatically assigns unique IDs to each article, we recommend using the same article IDs in Ada.
As a best practice, use unique IDs that don’t replicate article titles, so the IDs don’t get lost if the article title changes. For example, for an article titled
Get started
, instead of usingget-started
as an ID, consider using a unique identifier that is independent from the article’s content, likeabc123xyz789
.
For generative bots, when you add an article into Ada, your bot will start using it for generated content. For scripted bots, your bot will begin suggesting articles if you have the appropriate features enabled.
Article properties
id
: a unique identifier for the articlename
: the name or title of the articlecontent
: the content of the article in markdown formaturl
: (optional) the url of the articleknowledge_source_id
: theid
of theknowledge_source
the article belongs tolanguage
: (optional) the ISO 639-1 language code of the article; defaults toen
tag_ids
: (optional) uniqueid
s that correspond to tags you can assign to each articleexternal_created
: (optional) the date the article was created in the source systemexternal_updated
: (optional) the date the article was last updated in the source systemenabled
: (optional) whether the article should be referenced during response generation; defaults totrue
metadata
: (optional) a dictionary of arbitrary key,value pairs. Ada doesn't use this data, but you can use it to store additional information about the article