Skip to main content

Case Documents

Pin or remove documents within a case. Pinned documents are highlighted in the case view and preserved during case operations.

Manage document membership within a case. Pin a document to mark it as important — pinned documents are highlighted in the UI and preserved during split operations. Remove a document to detach it from the case entirely.

Use pinning to flag key documents during case review — for example, pin the primary invoice in a multi-document case so it stays visible. Use removal when a document was incorrectly linked and should not belong to this case. Both operations are immediate and do not require a recompute.

Pin returns { "success": true } on success. Remove also returns { "success": true }. Both endpoints return 404 if the case or document is not found. The pin status is reflected in the case detail response from GET /v1/cases/:key.

Pinned documents are preserved in the original partition during split operations — they always stay with the case they are pinned to. If you plan to split a case, pin the anchor documents first. Removed documents may reappear in the case after a recompute if linking edges still connect them.

Removing a document from a case does not delete the document itself. The document remains in your workspace and may be re-linked into a case during the next recompute cycle if linking edges still exist.
POST/v1/cases/:key/documents/:docId/pin

Response

Response fields

successbooleanAlways true on success.

Response

{ "success": true }
DELETE/v1/cases/:key/documents/:docId

Response

Response fields

successbooleanAlways true on success.

Response

{ "success": 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.