Add via API
Learn how to add Knowledge Base articles programmatically using the API
The Knowledge Base Article Submission API offers an alternative to manual creation of article snippets and URL imports. This is especially beneficial for large data sources that are not easily scraped, such as internal knowledge bases or articles within a Content Management System.
All content imported via API follow the Imported Articles review process.
Before you Begin
Before using the Knowledge Base Article Submission API, you need to:
- Get your API Key Id and Secret
- Ensure your API key has been configured to access Knowledge Base APIs. Reach out to your ASAPP team if you need access enabled.
Step 1: Create a submission
To import an article via API, you need to create a submission
. A submission is the attempt to import an article. It will still need to be reviewed and published like any other imported article.
To create a submission, you need to specify:
title
: The title of the articlecontent
: The content of the article
There are additional optional fields that can be used to improve the articles such as url
, metadata
, and queryExamples
. More information can be found in the API Reference.
As an example, here’s a request to create a submission for an article including additional values such as url
and metadata
:
Step 2: Article Processing
The Article Submission API submits the article that will still need to be reviewed and published like any other imported article.
You can check the status of the submission by calling the Get a Submission API.
The response will include the id
of the submission and the status
of the submission.
Step 3: Publication and Updates
Once the submission is approved, the article will be published and become available in the Knowledge Base. The status of the submission will be updated to ACCEPTED
and you will see it within the ASAPP AI-Console UI.
You can also update the article after it has been published by creating another submission with the same articleId
.
Troubleshooting
Common API response codes and their solutions:
Next Steps
Was this page helpful?