Cases

Pin a document to a case

Manually pin a document to a case so it persists across re-clustering.

post/v1/cases/{key}/documents/{docId}/pin

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/cases/{key}/documents/{docId}/pin
  • Auth: HTTP bearer

Path parameters

keystring uuid required

Case UUID (the stable resource id).

docIdstring uuid required

Document identifier to pin.

Response

Document pinned.

idstring uuid required

Case UUID — the stable resource id used in API paths.

case_keystring required

Content-derived key (hex hash of the member document set); distinct from id.

labelstring nullable
narrativestring nullable
anomaly_countinteger required
created_atstring date-time nullable

Example response

{
  "case_key": "8c1ca050535e3ea3",
  "documents": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "filename": "invoice-042.pdf",
      "created_at": "2026-04-25T14:30:00.000Z"
    }
  ],
  "created_at": "2026-04-25T14:30:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.