GET
/
knowledge-base
/
v1
/
submissions
/
{id}
curl --request GET \
  --url https://api.test.asapp.com/knowledge-base/v1/submissions/{id} \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>'
{
  "id": "fddd060c-22d7-4aed-acae-8f8dcc093a88",
  "articleId": "8f8dcc09-22d7-4aed-acae-fddd060c3a88",
  "submittedAt": "2024-12-12T00:00:00Z",
  "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

Path Parameters

​
id
string
required

The unique identifier for the submission to be retrieved.

Response

200
application/json
Submission successfully retrieved

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

​
id
string

The unique identifier for the submission.

Example:

"fddd060c-22d7-4aed-acae-8f8dcc093a88"

​
articleId
string

The unique identifier for the article related to the submission.

Example:

"8f8dcc09-22d7-4aed-acae-fddd060c3a88"

​
submittedAt
string

The timestamp when the submission was created.

Example:

"2024-12-12T00:00:00Z"

​
title
string

The article title, either original or refined.

Example:

"5G Data Plan"

​
content
string

The article content, either original or refined.

Example:

"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
string

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

Example:

"https://example.com/5g-data-plans"

​
metadata
object[]

Additional key-value pairs related to the article.

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

Example:
[
  {
    "key": "department",
    "value": "Customer experience"
  }
]
​
queryExamples
string[]

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

Example:
[
  "What 5G plans do you offer?",
  "Is there an unlimited 5G plan?"
]
​
additionalInstructions
object[]

Specific instructions to ensure responses are relevant and address exceptions.

Guidelines and responses to enhance the article.

Example:
[
  {
    "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
enum<string>

The current status of the submission.

Available options:
PENDING_REVIEW,
ACCEPTED,
REJECTED
Example:

"PENDING_REVIEW"

Was this page helpful?