post https://example.ada.support/api/knowledge/v1/articles
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.
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.
Note for generative bots: While the API allows you to create articles in any language, your bot uses only English (
en
) articles to generate bot content.
Article Properties
id
: a unique identifier for the articlename
: the name or title of the articlecontent
: the content of the article in markdown formaturl
: the url of the articlelanguage
: (optional) the ISO 639-1 language code of the article; defaults toen
knowledge_source_id
: theid
of theknowledge_source
the article belongs toexternal_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