Extractions

Correct extraction data

Submit field-level corrections. Each key in the body is a field name; the value is the corrected value. Corrected fields are locked at confidence 1.0.

Corrections are written to the value plane as new cell versions (source: api_correction) and mirrored into the extraction data. They pass the central cell-write authority guard first: a field whose current value was promoted by review, or is held for approval, is withheld and reported in cells_skipped instead of being overwritten. A document that has no capture-layer record yet answers value_plane: "not_migrated" and is corrected in the extraction data only.

patch/v1/extractions/{id}/data

Request

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

Path parameters

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

Resource UUID.

Request body

object required

Object mapping field names to corrected values.

Example request

{
  "vendor_name": "Acme Corporation Ltd.",
  "total_amount": 1275.5
}

Response

Updated extraction with corrections applied.

idstring uuid required
status'complete' | 'failed' | 'processing' required
dataobject required

Extracted key-value pairs.

locked_fieldsstring[]

Fields that have been manually corrected (locked at confidence 1.0).

batch_idstring

The caller grouping key stamped on this document at ingestion (documents.client_batch_id) — e.g. from POST /v1/run or POST /v1/sources/:id/documents. Present only when set.

metadataobject

The caller's flat metadata bag stamped on this document at ingestion (documents.client_metadata) — for a /v1/run input, its per-request EFFECTIVE merged bag (call-level metadata merged with any file_metadata entry). Present only when set.

created_atstring date-time
value_plane'written' | 'not_migrated' required

written — the corrections landed as new value-plane cell versions. not_migrated — the document has no capture-layer record yet, so the correction was applied to the legacy extraction JSONB only.

cells_writtenstring[] required

Field names that became new value-plane cell versions.

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "completed",
  "document": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "filename": "invoice-042.pdf"
  },
  "processing": {
    "region": "eu-west"
  },
  "created_at": "2026-04-25T14:30:00.000Z"
}

Changes

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