Withdraw a document
POST/v1/projects/:project_id/documents/:document_id/withdraw
Takes a document out of every default read while keeping its history. The withdrawal is archived as a tombstone version, so one mechanism answers what a document holds now and there is no second lifecycle flag for a reader to miss.
Its chunks are dropped from the knowledge index, so a withdrawn document costs a live search nothing. The content is not lost with them: it is in the version before the tombstone, which POST /v1/projects/{project_id}/documents/{document_id}/versions/{version}/restore re-chunks from.
DELETE stays what it is — permanent, and it removes the backing file. Withdrawal is the reversible act. It does not apply under /.system/: a platform-written document keeps the owning module's lifecycle.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 413
- 429
- 500
- 502
- 4XX
The withdrawn document
Bad Request — the document is filed under the reserved root
Unauthorized
Forbidden
Document not found
The document is already withdrawn (DOCUMENT_ALREADY_WITHDRAWN), or it has moved past the version this write read (VERSION_CONFLICT, with meta.current_version).
REQUEST_REJECTED — the request body is over the size the body parser accepts
QUOTA_EXCEEDED — a requests quota on the calling API key or its project is spent for the window; Retry-After says when it reopens
Response Headers
Seconds until the quota window admits a request again
Unexpected server error — INTERNAL_ERROR, with the raw message never forwarded
The deployment's admission service is asked about this write and did not answer — ADMISSION_UNAVAILABLE; the write did not happen
The deployment's admission service refused this write — answered under the service's own 4xx status, with its code (matching ^[A-Za-z_][A-Za-z0-9_]{0,63}$, not necessarily an ERROR_CODES key), message and meta; the write did not happen. A status this operation also declares on its own is documented there