Skip to navigation

Delete document

Deletes a document and everything indexed from it, and returns its id with deleted: true. The agents stop answering from it, and the deletion cannot be undone: to use the content again, add the document anew. A document of another organization, or one that does not exist, gives 404 not_found. With a test key the document is checked but NOT deleted: the response has simulated: true. Required scope: knowledge:write. With a test key (vx_test_) it is simulated: nothing real happens and nothing is billed. Accepts an optional Idempotency-Key header. Retriable: when the operation itself fails with a 429, a 5xx or a temporary 409, the key is released and a retry with the same key runs the operation again; with no response at all, a retry with the same key returns the first outcome or runs the operation again. A 429 rate_limited from the request limit and 409 request_in_progress come before the operation and leave the key as it is: retry with the same key.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Path parameters

document_idstringRequiredformat: "uuid"

Id of the document, as returned by GET /knowledge/documents or when it was added.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:
Idempotency-KeystringOptionalformat: "^[A-Za-z0-9_-]{16,64}$"

A unique value you generate for each new operation (16 to 64 letters, digits, hyphen or underscore; a UUID works). Repeating the same request with the same key within 24 hours returns the first response and does nothing again, when that response was a success or a 4xx error the same request would always get again (not 429, and not the temporary 409 codes request_in_progress, caller_has_active_call and caller_request_in_progress: for those, and for a 5xx, see the note on retrying in the operation); the same key with a different request is refused with idempotency_key_reused.

Response

Successful response.
object"knowledge_document"

Always knowledge_document.

idstringformat: "uuid"
Id of the document that was deleted.
deletedtrue

Always true.

simulatedboolean

true with a test key: the document exists and was NOT deleted.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error