Skip to main content

Correct Extraction

Override extracted field values with POST /v1/extractions/:id/correct. Each corrected field is written at confidence 1.0 and locked as ground truth.

The Correct Extraction endpoint, POST /v1/extractions/:id/correct, overrides field values on an extraction. Pass a flat map of field name to corrected value; each field you set is written at confidence 1.0 and locked, so it is treated as ground truth and not re-derived. Use it to fix a misread value programmatically without re-running extraction.

A typical workflow is to read the extraction with GET /v1/extractions/:id, spot the fields whose confidence is low or whose values fail your own validation, and post the known-good values here. Fields you do not include are left unchanged.

This endpoint requires write scope. The equivalent PATCH /v1/extractions/:id/data accepts the same flat field-to-value map and returns the full updated extraction in its response.
POST/v1/extractions/:id/correct

Path parameters

id*stringThe extraction UUID.

curl

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundNo extraction with this ID exists for your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.