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.
Body
A proposal for creating a new article or updating an existing one in the Knowledge Base.
Specific instructions to ensure responses are relevant and address exceptions.
The unique identifier for the article being updated.
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.
1 - 200000
Additional key-value pairs related to the article.
Examples of customer questions related to the article, such as "Why is my bill so high?". Defaults to an empty list if not provided.
The proposed title of the article, which will be refined automatically. This is required for new articles.
1 - 256
A reference URL for the article, used for informational purposes only.
Response
Information about a successfully submitted proposal to update an article in the Knowledge Base.
Specific instructions to ensure responses are relevant and address exceptions.
The unique identifier for the article related to the submission.
The article content, either original or refined.
The unique identifier for the submission.
Additional key-value pairs related to the article.
Examples of customer questions related to the article. Defaults to an empty array if not provided.
The current status of the submission.
PENDING_REVIEW
, ACCEPTED
, REJECTED
The timestamp when the submission was created.
The article title, either original or refined.
The reference URL of the article. Defaults to an empty string if not provided.
Was this page helpful?