Create Document

Create a new knowledge document.

POST /api/v1/documents

Create Document

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/documents \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "<string>",
  "content": "<string>",
  "source_id": "<string>",
  "parent_id": "<string>",
  "position": 123,
  "status": "<string>",
  "default_language": "en"
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/documents"

payload = {
    "title": "<string>",
    "content": "<string>",
    "source_id": "<string>",
    "parent_id": "<string>",
    "position": 123,
    "status": "<string>",
    "default_language": "en"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    content: '<string>',
    source_id: '<string>',
    parent_id: '<string>',
    position: 123,
    status: '<string>',
    default_language: 'en'
  })
};

fetch('https://{tenant_id}.api.useago.com/api/v1/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

201

{
  "id": "<string>",
  "title": "<string>",
  "object": "document",
  "page_id": "<string>",
  "content": "<string>",
  "override_content": "<string>",
  "related_questions": "<string>",
  "status": "<string>",
  "public_display": true,
  "default_language": "en",
  "source_id": "<string>",
  "source_name": "<string>",
  "parent_id": "<string>",
  "position": 0,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key · string · header · required

Body

application/json

Schema for creating a document via the v1 API.

title · string · required

content · string | null

source_id · string | null

parent_id · string | null

position · integer | null

status · string | null

default_language · string · default: en

Response

201 - application/json

Created

Stripe-aligned document response.

id · string · required

title · string · required

object · string · default: document

page_id · string | null

content · string | null

override_content · string | null

related_questions · string | null

status · string | null

public_display · boolean · default: true

default_language · string · default: en

source_id · string | null

source_name · string | null

parent_id · string | null

position · integer · default: 0

created_at · string<date-time> | null

updated_at · string<date-time> | null