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 article
  • name: the name or title of the article
  • content: the content of the article in markdown format
  • url: the url of the article
  • language: (optional) the ISO 639-1 language code of the article; defaults to en
  • knowledge_source_id: the id of the knowledge_source the article belongs to
  • external_created: (optional) the date the article was created in the source system
  • external_updated: (optional) the date the article was last updated in the source system
  • enabled: (optional) whether the article should be referenced during response generation; defaults to true
  • 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
Click Try It! to start a request and see the response here!