GET
/
knowledge-base
/
v1
/
articles
/
{id}

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

An article stored within the Knowledge Base.

additionalInstructions
object[]

Specific instructions to ensure responses are relevant and address exceptions.

content
string

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

currentVersion
string

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

deploymentStatus
enum<string>

The current deployment status of the article.

Available options:
NONE,
DRAFT,
SANDBOX,
PRODUCTION,
SANDBOX_AND_PRODUCTION
id
string

The unique identifier for the article.

metadata
object[]

Additional key-value pairs related to the article.

originalContent
string

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

originalTitle
string

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

pendingSubmissionId
string

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

queryExamples
string[]

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

title
string

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

updatedAt
string

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

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.

url
string

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