Bulk Create Documents

Bulk create knowledge documents (max 100 per request).

An item carrying a ‘page_id’ that already exists in the target source updates that document instead of creating a duplicate, so re-running an import is safe.

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>",
      "page_id": "<string>",
      "position": 123,
      "status": "<string>",
      "default_language": "en"
    }
  ]
}
'

200

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

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

updated · Updated · object[]

total_updated · integer · default: 0