Skip to main content
POST
Delete documents

Path Parameters

workspaceId
string<uuid>
required

Workspace identifier.

Body

application/json

Request to delete several documents in one call.

The 100-id cap bounds the work one call fans out into: the resolve query and the delete transaction.

Request to delete several documents in one call.

The 100-id cap bounds the work one call fans out into: the resolve query and the delete transaction.

documentIds
string<uuid>[]
required

Ids of the documents to delete. Ids that are unknown, already deleted, or in another workspace are skipped rather than failing the request.

Required array length: 1 - 100 elements

Response

Result of a bulk document deletion.

The deletion is idempotent: deleted holds the ids that resolved to live documents in the workspace and were removed, and skipped holds the requested ids that did not — unknown, already deleted, in another workspace, or held by an in-progress detection that still needs the document.

Result of a bulk document deletion.

The deletion is idempotent: deleted holds the ids that resolved to live documents in the workspace and were removed, and skipped holds the requested ids that did not — unknown, already deleted, in another workspace, or held by an in-progress detection that still needs the document.

deleted
string<uuid>[]
required

Ids that were deleted.

skipped
string<uuid>[]
required

Requested ids that were skipped: unknown, already deleted, in another workspace, or held by an in-progress detection.