GET
/
knowledge-base
/
v1
/
articles
/
{id}
curl --request GET \
  --url https://api.test.asapp.com/knowledge-base/v1/articles/{id} \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>'
{
  "id": "fddd060c-22d7-4aed-acae-8f8dcc093a88",
  "updatedAt": "2024-12-12T00:00:00",
  "updatedBy": "user@company.com",
  "title": "5G Data Plan Overview",
  "content": "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": "https://example.com/5g-data-plans",
  "metadata": [
    {
      "key": "department",
      "value": "Customer experience"
    }
  ],
  "originalContent": "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": "5G Data Plan",
  "queryExamples": [
    "What 5G plans do you offer?",
    "Is there a family plan for 5G?"
  ],
  "additionalInstructions": [
    {
      "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": "86ba487a-6d58-4b4c-82de-9d422f1166ae",
  "currentVersion": "v1",
  "deploymentStatus": "DRAFT"
}

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.