Bulk Delete Documents

Bulk delete knowledge documents (max 100 per request).

POST /api/v1/documents/bulk-delete

Bulk Delete Documents

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/documents/bulk-delete \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "document_ids": [
    "<string>"
  ]
}
'

import requests

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

payload = { "document_ids": ["<string>"] }
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({document_ids: ['<string>']})
};

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

200

{
  "deleted": 123,
  "not_found": [
    "<string>"
  ],
  "errors": [
    {}
  ],
  "object": "bulk_result"
}

Authorizations

X-API-Key · string · header · required

Body

application/json

Schema for bulk deleting documents. Max 100 IDs per request.

document_ids · string[] · required

Response

200 - application/json

OK

Response schema for bulk document deletion.

deleted · integer · required

not_found · string[] · required

errors · Errors · object[] · required

object · string · default: bulk_result