Documents

Update a document's caller tags

Post-ingest update of the caller tags accepted at upload time (batch_id and metadata). metadata is MERGED over the stored bag — a patch key wins, null is a stored value (never a deletion), and the merged bag must satisfy the same caps as at ingest (≤50 keys, key ≤128 chars, string value ≤1024 chars) or the request is rejected with the document unchanged. batch_id is three-state: a non-blank string sets it, null clears it, and omitting the field leaves it untouched. Note that a byte-identical re-upload does NOT update tags (dedup keeps the canonical document's original tags) — this endpoint is the way to change what an existing document id carries. Pipelines read batch_id/metadata at run time, so a later run or rerun of the document picks the new tags up.

patch/v1/documents/{id}

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/documents/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Resource UUID.

Request body

batch_idstring nullable

Grouping key — string sets, null clears, absent untouched.

metadataobject

Flat primitive bag merged over the stored metadata.

Response

Updated tags. batch_id/metadata are echoed only when set.

idstring uuid required
updatedboolean required
batch_idstring
metadataobject

Changes

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