Skip to main content

Case Documents

Pin a document to a case so it survives rebuilds, or remove a wrongly linked document. Both curator decisions persist across case recomputes.

Manage document membership within a case. Pin a document to lock it into the case: pinned documents survive rebuilds even when the rebuild would otherwise drop them. Remove a document to detach it from the case when it was linked incorrectly.

Both operations are curator overrides, and both persist. A removed document is tombstoned on the case, so the next rebuild does not re-add it even if linking edges still connect it. Pinning a document that is not currently a member adds it to the case, provided the document belongs to your workspace.

Each endpoint returns the updated membership record for the document. The pin state is also visible as the pinned flag on each entry of the documents array in GET /v1/cases/:key.

Removing a document from a case does not delete the document itself. The document remains in your workspace and can still appear in other cases; only its membership in this case is tombstoned.
POST/v1/cases/:key/documents/:docId/pin

Response

Response fields

document_idstringUUID of the pinned document.
pinnedbooleanTrue after a pin.
removedbooleanFalse: pinning clears a previous removal.

Response

{
  "document_id": "doc_uuid_1",
  "pinned": true,
  "removed": false
}
DELETE/v1/cases/:key/documents/:docId

Response

Response

{
  "document_id": "doc_uuid_1",
  "pinned": false,
  "removed": true
}

Errors

Error responses

400bad_requestInvalid case key or document ID format.
401unauthorizedMissing or invalid API key.
404not_foundCase not found.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.