Create a submission

Initiate a request to add a new article or update an existing one. The provided title and content will be processed to create the final version of the submission.

POST /knowledge-base/v1/submissions

Create a submission

cURL

curl --request POST \
  --url https://api.test.asapp.com/knowledge-base/v1/submissions \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '
{
  "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."
    }
  ]
}
'

import requests

url = "https://api.test.asapp.com/knowledge-base/v1/submissions"

payload = {
    "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."
        }
    ]
}
headers = {
    "asapp-api-id": "<api-key>",
    "asapp-api-secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'asapp-api-id': '<api-key>',
    'asapp-api-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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.'
      }
    ]
  })
};

fetch('https://api.test.asapp.com/knowledge-base/v1/submissions', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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.'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.test.asapp.com/knowledge-base/v1/submissions"

	payload := strings.NewReader("{\n  \"title\": \"5G Data Plan\",\n  \"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.\",\n  \"url\": \"https://example.com/5g-data-plans\",\n  \"metadata\": [\n    {\n      \"key\": \"department\",\n      \"value\": \"Customer experience\"\n    }\n  ],\n  \"queryExamples\": [\n    \"What 5G plans do you offer?\",\n    \"Is there an unlimited 5G plan?\"\n  ],\n  \"additionalInstructions\": [\n    {\n      \"clarificationInstruction\": \"Emphasize that 5G coverage may vary by location\",\n      \"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.\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("asapp-api-id", "<api-key>")
	req.Header.Add("asapp-api-secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.test.asapp.com/knowledge-base/v1/submissions")
  .header("asapp-api-id", "<api-key>")
  .header("asapp-api-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"5G Data Plan\",\n  \"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.\",\n  \"url\": \"https://example.com/5g-data-plans\",\n  \"metadata\": [\n    {\n      \"key\": \"department\",\n      \"value\": \"Customer experience\"\n    }\n  ],\n  \"queryExamples\": [\n    \"What 5G plans do you offer?\",\n    \"Is there an unlimited 5G plan?\"\n  ],\n  \"additionalInstructions\": [\n    {\n      \"clarificationInstruction\": \"Emphasize that 5G coverage may vary by location\",\n      \"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.\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.test.asapp.com/knowledge-base/v1/submissions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["asapp-api-id"] = '<api-key>'
request["asapp-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"5G Data Plan\",\n  \"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.\",\n  \"url\": \"https://example.com/5g-data-plans\",\n  \"metadata\": [\n    {\n      \"key\": \"department\",\n      \"value\": \"Customer experience\"\n    }\n  ],\n  \"queryExamples\": [\n    \"What 5G plans do you offer?\",\n    \"Is there an unlimited 5G plan?\"\n  ],\n  \"additionalInstructions\": [\n    {\n      \"clarificationInstruction\": \"Emphasize that 5G coverage may vary by location\",\n      \"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.\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": "fddd060c-22d7-4aed-acae-8f8dcc093a88",
  "articleId": "8f8dcc09-22d7-4aed-acae-fddd060c3a88",
  "submittedAt": "2024-12-12T00:00:00",
  "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": "413-01",
    "message": "Request Entity Too Large"
  }
}

{
  "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"
  }
}

Authorizations

asapp-api-id · string · header · required

asapp-api-secret · string · header · required

Body

application/json

A proposal for creating a new article or updating an existing one in the Knowledge Base.

articleId · string

The unique identifier for the article being updated.

Example:

"8f8dcc09-22d7-4aed-acae-fddd060c3a88"

title · string

The proposed title of the article, which will be refined automatically. This is required for new articles.

Required string length: 1 - 256

Example:

"5G Data Plan"

content · string

The article content in plain text, expected to be in English and limited to 200,000 Unicode characters. This will be refined during submission. Required for new articles.

Required string length: 1 - 200000

Example:

"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 · string

A reference URL for the article, used for informational purposes only.

Example:

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

metadata · object[]

Additional key-value pairs related to the article.

Show child attributes

Example:

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

queryExamples · string[]

Examples of customer questions related to the article, such as "Why is my bill so high?". Defaults to an empty list if not provided.

Example:

[
  "What 5G plans do you offer?",
  "Is there an unlimited 5G plan?"
]

additionalInstructions · object[]

Specific instructions to ensure responses are relevant and address exceptions.

Show child attributes

Example:

[
  {
    "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."
  }
]

Response

201

application/json

Submission successfully created

Information about a successfully submitted proposal to update an article in the Knowledge Base.

id · string

The unique identifier for the submission.

Example:

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

articleId · string

The unique identifier for the article related to the submission.

Example:

"8f8dcc09-22d7-4aed-acae-fddd060c3a88"

submittedAt · string<date-time>

The timestamp when the submission was created.

Example:

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

title · string

The article title, either original or refined.

Example:

"5G Data Plan"

content · string

The article content, either original or refined.

Example:

"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 · string

The reference URL of the article. Defaults to an empty string if not provided.

Example:

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

metadata · object[]

Additional key-value pairs related to the article.

Show child attributes

Example:

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

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 an unlimited 5G plan?"
]

additionalInstructions · object[]

Specific instructions to ensure responses are relevant and address exceptions.

Show child attributes

Example:

[
  {
    "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 · enum<string>

The current status of the submission.

Available options: PENDING_REVIEW, ACCEPTED, REJECTED

Example:

"PENDING_REVIEW"