Get Resolution

Retrieve a resolution run by ID with its status, documents processed count, completion timestamp, and links to results. Poll this endpoint to track progress.

Retrieve the current status and metadata of a specific resolution run by its UUID. The response includes the run status, the number of documents processed, the completion timestamp, and a link to the results endpoint where you can inspect per-field resolved values. Use this endpoint to poll for completion after executing a resolution.

GET/v1/resolutions/{id}

Path parameters

id*uuidResolution run UUID.

curl

Response

Response fields

idstringResolution run UUID.

source_run_idstringUUID of the originating job run.

statusstringRun status: pending, running, completed, or failed.

documents_processedinteger | nullNumber of documents processed, or null before processing starts.

created_atstringISO 8601 creation timestamp.

completed_atstring | nullISO 8601 completion timestamp, or null while the run is in progress.

linksobjectRelated resource URLs (self, results).

Response

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

This endpoint is typically used in a polling loop after calling POST /v1/resolutions/{id}/execute. Watch for status transitioning from running to completed or failed. Once completed, use GET /v1/resolutions/{id}/results to inspect per-field resolved values and the resolution_step that produced each canonical mapping.

Poll at a modest interval (every few seconds) to stay well within rate limits. Deterministic policy rules finish in seconds; runs whose policy invokes LLM-assisted matching for ambiguous values can take several minutes.

Errors

Error responses

401unauthorizedMissing or invalid API key.

404not_foundResolution 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

Get Resolution Results