Bulk Create Documents

Bulk create knowledge documents (max 100 per request).

POST /api/v1/documents/bulk

Bulk Create Documents

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/documents/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "items": [
    {
      "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/bulk"

payload = { "items": [
        {
            "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({
    items: [
      {
        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/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "created": [
    {}
  ],
  "errors": [
    {}
  ],
  "total_created": 123,
  "total_errors": 123,
  "object": "bulk_result"
}

Authorizations

X-API-Key · string · header · required

Body

application/json

Schema for bulk creating documents. Max 100 items per request.

items · DocumentCreateIn · object[] · required

Show child attributes

Response

200 - application/json

OK

Response schema for bulk document creation.

created · Created · object[] · required

errors · Errors · object[] · required

total_created · integer · required

total_errors · integer · required

object · string · default: bulk_result