Knowledge Base

Create a submission

Initiate a request to add a new article or update an existing one.

The provided title and content will be processed to create the final version of the submission.

A submission is the programmatic creation or editing of an article. All submissions need to be approved by a human in the ASAPP Console in order to be applied.

All content in a submission may be refined by our AI in order to make it easy to be used by GenerativeAgent

Head to Connecting your Knowledge Base to see how to enter the API from the ASAPP Console.

POST

knowledge-base

submissions

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."
    }
  ]
}'

{
  "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. 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."
    }
  ],
  "status": "PENDING_REVIEW"
}

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Body

application/json

A proposal for creating a new article or updating an existing one in the Knowledge Base.

articleId

string

The unique identifier for the article being updated.

title

string

The proposed title of the article, which will be refined automatically. This is required for new articles.

Required string length: 1 - 256

content

string

The article content in plain text, expected to be in English and limited to 200,000 Unicode characters. This will be refined during submission. Required for new articles.

Required string length: 1 - 200000

url

string

A reference URL for the article, used for informational purposes only.

metadata

object[]

Additional key-value pairs related to the article.

A key-value pair providing additional information about the article.

queryExamples

string[]

Examples of customer questions related to the article, such as "Why is my bill so high?". Defaults to an empty list if not provided.

additionalInstructions

object[]

Specific instructions to ensure responses are relevant and address exceptions.

Guidelines and responses to enhance the article.

Response

201

application/json

Submission successfully created

Information about a successfully submitted proposal to update an article in the Knowledge Base.

string

The unique identifier for the submission.

articleId

string

The unique identifier for the article related to the submission.

submittedAt

string

The timestamp when the submission was created.

title

string

The article title, either original or refined.

content

string

The article content, either original or refined.

url

string

The reference URL of the article. Defaults to an empty string if not provided.

metadata

object[]

Additional key-value pairs related to the article.

A key-value pair providing additional information about the article.

queryExamples

string[]

Examples of customer questions related to the article. Defaults to an empty array if not provided.

additionalInstructions

object[]

Specific instructions to ensure responses are relevant and address exceptions.

Guidelines and responses to enhance the article.

status

enum<string>

The current status of the submission.

Available options:

PENDING_REVIEW,

ACCEPTED,

REJECTED

Was this page helpful?

Delete a response folder Retrieve a submission

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."
    }
  ]
}'

{
  "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. 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."
    }
  ],
  "status": "PENDING_REVIEW"
}

ASAPP APIs

Authorizations

Body

Response