Cancel processing of the pending version
POST/v1/knowledge_bases/:kb_id/documents/:document_id/cancel
Allowed in uploaded, validating, queued, processing and awaiting_budget (for the first version or a pending replacement). Embedding tokens already produced are billed; unstarted work is free. A document with no ready version ends cancelled; with a ready version the pending replacement is dropped and the document stays ready.
Access: API key scope knowledge:write; portal users: organization admins and owners; the knowledge base in the path must be on the key's access list.
Request
Responses
- 202
- 403
- 404
- 409
Cancellation accepted.
scope_missing, kb_not_in_allowlist, role_insufficient, actor_not_permitted, tenant_suspended, module_disabled (knowledge bases switched off on the platform: an operation that creates data or starts processing, for an organization that still has knowledge bases), web_sources_disabled, domain_blocked, domain_not_verified (website sources)
not_found (absent or owned by another organization — identical), module_disabled
idempotency_key_conflict, idempotency_in_progress, version_conflict, duplicate_content, kb_suspended, kb_deleting, document_deleting, document_not_ready, invalid_document_state, trial_kb_frozen, resource_limit_reached, export_in_progress, source_sync_in_progress, invalid_source_state, duplicate_source