Run

Get this run's structured results (poll-able, per-document)

The same governed results read as GET /v1/pipelines/{id}/results (review holdback, demoted-field projection, assembly awareness), scoped ALWAYS to this /v1/run request's own documents[] echo and ALWAYS the per-document view — "what did MY submitted documents produce," uniform across new/append pipeline modes. This is a deliberate DIVERGENCE from the per-run run.completed webhook, which for an unscoped non-append assembly run delivers COMPOSED rows: composed output for an assembly run is GET /v1/pipelines/{id}/results?view=composed, surfaced here at links.composed_results when a pipeline exists.

Only document_id and include filter the rows; run_id, view, since, until, and status are pipeline-route-only and 400 with unsupported_filter here, since the run IS the scope and its window is already bounded. include=cells,provenance,audit behave identically to the pipeline route — including the structured-subfield type projection on fields/cells and the raw, non-projected audit trail — see GET /v1/pipelines/{id}/results for the full shape and held-value redaction rules.

Two zero-states return 200 with an empty page and a scope_note, never 404: no compiled pipeline exists yet for this run (still ingesting, or it failed before pipeline creation), or the run predates per-request document tracking (an echo-less legacy row, whose membership is unknowable). The envelope's status folds the same three-state vocabulary as GET /v1/run/{id} (processing/completed/failed) and DOES settle even for an append pipeline that never settles at the pipeline level — poll this route for append consumers instead of the pipeline route. Requires read scope.

get/v1/run/{id}/results

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/run/{id}/results
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

document_idstring

Comma-separated document UUIDs (1-100), intersected with the run's own documents echo.

includestring

Comma-separated subset of cells, provenance, provenance.nested, audit. provenance returns one entry per field (kind, quote, match grade, confidence, path, markdown offsets) — see ResultsProvenance; provenance.nested adds one entry per scalar leaf of a structured (array/object) field, keyed by the escaped dot-path.

limitinteger

Maximum records per page (default 25, max 100).

cursorstring

Opaque pagination cursor from a previous response's pagination.next_cursor, keyed on record_id.

Response

This run's results page (always the documents view).

run_idstring uuid required
pipeline_idstring uuid nullable required

Null while the run has no compiled pipeline yet.

spec_idstring uuid required
status'processing' | 'completed' | 'failed' | 'cancelled' required

The folded public run status (same vocabulary as GET /v1/run/{id}) — settles even for an append pipeline that never settles at the pipeline level.

view'documents' required

Always documents on this route.

generated_atstring date-time required
pending_review_countinteger required
scope_notestring

Present only for the two zero-states — no pipeline yet, or an echo-less legacy run.

Changes

No recorded changes to this operation across all 1 revision of this API.