Retrieve an article

Fetch a specific article by its unique identifier. If the article has not been created because the associated submission was not approved, a 404 status will be returned.

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Path Parameters

id

string

required

The unique identifier for the article to be retrieved.

Response

200

application/json

Article successfully retrieved

An article stored within the Knowledge Base.

id

string

The unique identifier for the article.

Example:

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

title

string

The refined title of the article, resulting from the cleanup process.

Example:

"5G Data Plan Overview"

content

string

The refined content of the article, resulting from the cleanup process.

Example:

"Our 5G data plans includes 75GB of data per month, while the Unlimited 5G plan offers unlimited data with no speed caps. Both plans include unlimited calls and texts within the country. International roaming is available for an additional fee."

url

string

The reference URL of the article. Defaults to null if not provided.

Example:

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

updatedAt

string

The timestamp indicating when the article was last updated. This field is null if the initial submission is still pending review.

Example:

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

updatedBy

string

The email address of the user who last updated the article. This field is null if the initial submission is still pending review.

Example:

"[e-mail]"

metadata

object[]

Additional key-value pairs related to the article.

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

Show child attributes

metadata.key

string

required

The key for the metadata entry.

Minimum length: 1

Example:

"department"

metadata.value

string

required

The value for the metadata entry.

Minimum length: 1

Example:

"Customer experience"

Example:

[
  {
    "key": "department",
    "value": "Customer experience"
  }
]

originalContent

string

The original content of the article prior to the cleanup process.

Example:

"Our 5G data plans offer lightning-fast speeds and generous data allowances. The Basic 5G plan now includes 75GB 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."

originalTitle

string

The original title of the article prior to the cleanup process.

Example:

"5G Data Plan"

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 a family plan for 5G?"
]

additionalInstructions

object[]

Specific instructions to ensure responses are relevant and address exceptions.

Guidelines and responses to enhance the article.

Show child attributes

additionalInstructions.clarificationInstruction

string

A guideline to improve the article's content.

Example:

"Emphasize that 5G coverage may vary by location"

additionalInstructions.exampleResponse

string

A sample response applicable if the clarification instruction is followed.

Example:

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

Example:

[
  {
    "clarificationInstruction": "Emphasize that 5G coverage may vary by location and mention the new Family Plan option",
    "exampleResponse": "Our 5G plans offer great speeds and data allowances, including our new Family Plan. Please note that 5G coverage may vary depending on your location. You can check coverage in your area on our website."
  }
]

pendingSubmissionId

string

The unique identifier for the submission currently under review for this article. This field is null if there are no pending submissions.

Example:

"86ba487a-6d58-4b4c-82de-9d422f1166ae"

currentVersion

string

The current version label of the article. This field is null if the initial submission is still pending review.

Example:

"v1"

deploymentStatus

enum<string>

The current deployment status of the article.

Available options:

NONE,

DRAFT,

SANDBOX,

PRODUCTION,

SANDBOX_AND_PRODUCTION

Example:

"DRAFT"