Skip to main content

Execute Resolution

Execute the resolution pipeline on all pending fields. Returns immediately — poll the run for progress. Requires write scope.

Start the resolution pipeline on a pending resolution run. The endpoint returns immediately with the updated run status (typically running). Poll the get resolution endpoint to track progress and check for completion.

Executing a resolution that is already running or completed has no effect. Only pending runs can be executed.
POST/v1/resolutions/{id}/execute

Response

Response fields

idstringResolution run UUID.
source_run_idstringUUID of the originating job run.
statusstringUpdated run status (typically running).
policy_snapshotobject | nullResolution policy configuration captured at run time.
dialect_snapshotobject | nullDialect configuration captured at run time.
error_messagestring | nullError detail if execution failed immediately.
created_atstringISO 8601 creation timestamp.
updated_atstringISO 8601 last update timestamp.
linksobjectRelated resource URLs (self, results, source_run).

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "source_run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "status": "running",
  "policy_snapshot": null,
  "dialect_snapshot": null,
  "error_message": null,
  "created_at": "2024-09-14T10:32:00.000Z",
  "updated_at": "2024-09-14T10:36: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"
  }
}

The standard workflow is POST /v1/resolutions to create, then POST /v1/resolutions/{id}/execute to start processing. The endpoint returns immediately with status: "running" -- poll GET /v1/resolutions/{id} to detect completion. Deterministic lookups complete in seconds; runs that trigger the LLM fallback for ambiguous values take 1-5 minutes depending on the number of unresolved fields.

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.