Create Resolution

Create a resolution run from a completed job to normalize extracted field values against reference data. Returns a pending run you start via execute.

Create a resolution run to normalize the field values extracted by a completed job run. The new run enters pending status immediately and does not start processing on its own: call the execute endpoint to start the pipeline. Pass the job run's UUID as source_run_id in the request body.

The source_run_id must reference a completed job run in your workspace. Requests that reference a missing, pending, or failed run are rejected.

POST/v1/resolutions

Body parameters

source_run_id*uuidID of the source run to resolve against.

Request body

{
  "source_run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}

curl

Response

Response fields (201 Created)

idstringResolution run UUID.

source_run_idstringUUID of the originating job run.

statusstringInitial status, always pending.

documents_processedinteger | nullAlways null on creation.

created_atstringISO 8601 creation timestamp.

completed_atstring | nullAlways null on creation.

linksobjectRelated resource URLs (self, results).

Response (201 Created)

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

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 it to complete, then create and execute a resolution against the job run. Each resolution run is independent, so you can re-run against the same job with a different Data Policy configuration without affecting previous results.

Errors

Error responses

400bad_requestInvalid request body, source run not eligible, or no specific organization context available (master-view API key used on a create operation).

401unauthorizedMissing or invalid API key.

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