Add via API - ASAPP Docs

The Knowledge Base Submission API offers an alternative to manual creation of Topic 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 follows the Imported Topics review process.

Before you Begin

Before using the Knowledge Base 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 content via API, you need to create a submission. A submission is the attempt to import content. It will still need to be reviewed and published like any other imported Topic. To create a submission, you need to specify:

title: The title of the Topic
content: The content of the Topic

There are additional optional fields that can be used to improve the Topics 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 a Topic including additional values such as url and metadata:

curl --request POST \
  --url https://api.sandbox.asapp.com/knowledge-base/v1/submissions \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '{
  "title": "5G Data Plan",
  "content": "Our 5G data plans offer lightning-fast speeds and generous data allowances. The Basic 5G plan includes 50GB of data per month, while our Unlimited 5G plan offers truly unlimited data with no speed caps. Both plans include unlimited calls and texts within the country. International roaming can be added for an additional fee.",
  "url": "https://example.com/5g-data-plans",
  "metadata": [
    {
      "key": "department",
      "value": "Customer experience"
    }
  ],
  "queryExamples": [
    "What 5G plans do you offer?",
    "Is there an unlimited 5G plan?"
  ],
  "additionalInstructions": [
    {
      "clarificationInstruction": "Emphasize that 5G coverage may vary by location",
      "exampleResponse": "Our 5G plans offer great speeds and data allowances, but please note that 5G coverage may vary depending on your location. You can check coverage in your area on our website."
    }
  ]
}'

Step 2: Topic Processing

The Topic Submission API submits the Topic that will still need review and publication like any other imported Topic. 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.

{
  "id": "fddd060c-22d7-4aed-acae-8f8dcc093a88",
  "articleId": "8f8dcc09-22d7-4aed-acae-fddd060c3a88",
  "submittedAt": "2024-12-12T00:00:00",
  "title": "5G Data Plan",
  "content": "Our 5G data plans offer lightning-fast speeds and generous data allowances...",
  "status": "PENDING_REVIEW"
}

Step 3: Publication and Updates

Once you approve the submission, the system will publish the Topic and make it available in the Knowledge Base. The status of the submission will update to ACCEPTED and you will see it within the ASAPP AI Console. You can also update the Topic after the system has published it by creating another submission with the same articleId.

Troubleshooting

Common API response codes and their solutions:

500 - Internal Server Error

If you receive a 500 code, there is an issue with the server. Wait and try again.If the error persists, contact your ASAPP Team.

400 - Bad Request

The 400 code usually means missing required parameters.Recheck your request body and try again.

401 - Unauthorized

A 401 code indicates incorrect credentials or unconfigured ASAPP credentials.

413 - Request Entity Too Large

The request body is too large. Topic content is limited to 200,000 Unicode characters.Try again with less content.

Next Steps

Knowledge Base API Reference

View the Knowledge Base API documentation

Connecting Your Knowledge Base

Learn more about managing your Knowledge Base Topics

Configuring GenerativeAgent

Configure how GenerativeAgent uses your Knowledge Base

Go Live

Deploy your Knowledge Base to production

​Before you Begin

​Step 1: Create a submission

​Step 2: Topic Processing

​Step 3: Publication and Updates

​Troubleshooting

​Next Steps

Knowledge Base API Reference

Connecting Your Knowledge Base

Configuring GenerativeAgent

Go Live

Before you Begin

Step 1: Create a submission

Step 2: Topic Processing

Step 3: Publication and Updates

Troubleshooting

Next Steps