Retrieve an article
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>'import requests
url = "https://api.test.asapp.com/knowledge-base/v1/articles/{id}"
headers = {
"asapp-api-id": "<api-key>",
"asapp-api-secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'asapp-api-id': '<api-key>', 'asapp-api-secret': '<api-key>'}
};
fetch('https://api.test.asapp.com/knowledge-base/v1/articles/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.test.asapp.com/knowledge-base/v1/articles/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"asapp-api-id: <api-key>",
"asapp-api-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.test.asapp.com/knowledge-base/v1/articles/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("asapp-api-id", "<api-key>")
req.Header.Add("asapp-api-secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.test.asapp.com/knowledge-base/v1/articles/{id}")
.header("asapp-api-id", "<api-key>")
.header("asapp-api-secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.test.asapp.com/knowledge-base/v1/articles/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["asapp-api-id"] = '<api-key>'
request["asapp-api-secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "400-01",
"message": "Bad request"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "401-01",
"message": "Unauthorized"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "403-01",
"message": "Forbidden Response"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "404-01",
"message": "Not Found"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "429-01",
"message": "Too Many Requests"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "503-01",
"message": "Service Unavailable"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "500-01",
"message": "Internal server error"
}
}Articles
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.
GET
/
knowledge-base
/
v1
/
articles
/
{id}
Retrieve an article
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>'import requests
url = "https://api.test.asapp.com/knowledge-base/v1/articles/{id}"
headers = {
"asapp-api-id": "<api-key>",
"asapp-api-secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'asapp-api-id': '<api-key>', 'asapp-api-secret': '<api-key>'}
};
fetch('https://api.test.asapp.com/knowledge-base/v1/articles/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.test.asapp.com/knowledge-base/v1/articles/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"asapp-api-id: <api-key>",
"asapp-api-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.test.asapp.com/knowledge-base/v1/articles/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("asapp-api-id", "<api-key>")
req.Header.Add("asapp-api-secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.test.asapp.com/knowledge-base/v1/articles/{id}")
.header("asapp-api-id", "<api-key>")
.header("asapp-api-secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.test.asapp.com/knowledge-base/v1/articles/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["asapp-api-id"] = '<api-key>'
request["asapp-api-secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "400-01",
"message": "Bad request"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "401-01",
"message": "Unauthorized"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "403-01",
"message": "Forbidden Response"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "404-01",
"message": "Not Found"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "429-01",
"message": "Too Many Requests"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "503-01",
"message": "Service Unavailable"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "500-01",
"message": "Internal server error"
}
}Path Parameters
The unique identifier for the article to be retrieved.
Response
Article successfully retrieved
An article stored within the Knowledge Base.
The unique identifier for the article.
Example:
"fddd060c-22d7-4aed-acae-8f8dcc093a88"
The refined title of the article, resulting from the cleanup process.
Example:
"5G Data Plan Overview"
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."
The reference URL of the article. Defaults to null if not provided.
Example:
"https://example.com/5g-data-plans"
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"
The email address of the user who last updated the article. This field is null if the initial submission is still pending review.
Example:
"user@company.com"
Additional key-value pairs related to the article.
Show child attributes
Show child attributes
Example:
[
{
"key": "department",
"value": "Customer experience"
}
]
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."
The original title of the article prior to the cleanup process.
Example:
"5G Data Plan"
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?"
]
Specific instructions to ensure responses are relevant and address exceptions.
Show child attributes
Show child attributes
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."
}
]
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"
The current version label of the article. This field is null if the initial submission is still pending review.
Example:
"v1"
The current deployment status of the article.
Available options:
NONE, DRAFT, SANDBOX, PRODUCTION, SANDBOX_AND_PRODUCTION Example:
"DRAFT"
Was this page helpful?