Create Resolution

Create a resolution run from a completed job to standardise extracted field values against reference data using lookup cascades and transforms.

Create a new resolution run targeting documents from a completed job run. The resolution enters pending status immediately. Call the execute endpoint to start processing, or it will be picked up automatically depending on your pipeline configuration.

The source_run_id must reference a completed job run. Creating a resolution against a pending or failed run returns a 404 error.

POST/v1/resolutions

Response

Response fields (201 Created)

idstringResolution run UUID.

source_run_idstringUUID of the originating job run.

statusstringInitial status, always pending.

policy_snapshotobject | nullResolution policy configuration captured at run time.

dialect_snapshotobject | nullDialect configuration captured at run time.

error_messagestring | nullAlways null on creation.

created_atstringISO 8601 creation timestamp.

updated_atstringISO 8601 last update timestamp.

linksobjectRelated resource URLs (self, results, source_run).

Response (201 Created)

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "source_run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "status": "pending",
  "policy_snapshot": null,
  "dialect_snapshot": null,
  "error_message": null,
  "created_at": "2024-09-14T10:32:00.000Z",
  "updated_at": "2024-09-14T10:32:00.000Z",
  "links": {
    "self": "/v1/resolutions/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "results": "/v1/resolutions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/results",
    "source_run": "/v1/jobs/b2c3d4e5-f6a7-8901-bcde-f12345678901"
  }
}

After creating a resolution, call POST /v1/resolutions/{id}/execute to start the pipeline. The typical workflow is: create a job via POST /v1/jobs, wait for complete status, then create and execute a resolution against the job's source_run_id. Each resolution captures its own policy and dialect snapshots, so you can re-run with different configurations without affecting previous results.

Errors

Error responses

400bad_requestNo specific customer context available (master-view API key used on a create operation).

401unauthorizedMissing or invalid API key.

404not_foundSource job run not found or does not belong to your organization.

429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

List Resolutions

Execute Resolution