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>'import requests
url = "https://api.test.asapp.com/knowledge-base/v1/submissions/{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/submissions/{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/submissions/{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/submissions/{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/submissions/{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/submissions/{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",
"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"
}{
"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"
}
}Retrieve a submission
Obtain the details of a specific submission using its unique identifier.
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>'import requests
url = "https://api.test.asapp.com/knowledge-base/v1/submissions/{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/submissions/{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/submissions/{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/submissions/{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/submissions/{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/submissions/{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",
"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"
}{
"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 submission to be retrieved.
Response
Submission successfully retrieved
Information about a successfully submitted proposal to update an article in the Knowledge Base.
The unique identifier for the submission.
"fddd060c-22d7-4aed-acae-8f8dcc093a88"
The unique identifier for the article related to the submission.
"8f8dcc09-22d7-4aed-acae-fddd060c3a88"
The timestamp when the submission was created.
"2024-12-12T00:00:00Z"
The article title, either original or refined.
"5G Data Plan"
The article content, either original or refined.
"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."
The reference URL of the article. Defaults to an empty string if not provided.
"https://example.com/5g-data-plans"
Additional key-value pairs related to the article.
Show child attributes
Show child attributes
[
{
"key": "department",
"value": "Customer experience"
}
]
Examples of customer questions related to the article. Defaults to an empty array if not provided.
[
"What 5G plans do you offer?",
"Is there an unlimited 5G plan?"
]
Specific instructions to ensure responses are relevant and address exceptions.
Show child attributes
Show child attributes
[
{
"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."
}
]
The current status of the submission.
PENDING_REVIEW, ACCEPTED, REJECTED "PENDING_REVIEW"
Was this page helpful?