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.

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.

Show child attributes

metadata.key

string

required

The key for the metadata entry.

Minimum length: 1

metadata.value

string

required

The value for the metadata entry.

Minimum length: 1

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.

Show child attributes

additionalInstructions.clarificationInstruction

string

A guideline to improve the article's content.

additionalInstructions.exampleResponse

string

A sample response applicable if the clarification instruction is followed.

Response

201

application/json

Submission successfully created

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

id

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.

Show child attributes

metadata.key

string

required

The key for the metadata entry.

Minimum length: 1

metadata.value

string

required

The value for the metadata entry.

Minimum length: 1

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.

Show child attributes

additionalInstructions.clarificationInstruction

string

A guideline to improve the article's content.

additionalInstructions.exampleResponse

string

A sample response applicable if the clarification instruction is followed.

status

enum<string>

The current status of the submission.

Available options:

PENDING_REVIEW,

ACCEPTED,

REJECTED