talonic_get_run_results
Read a Spec run's structured rows: one row per document, with the Spec's fields as clean values, plus the columns[] definitions that describe each field's key, display name and data type. Cells held for review serialize as null until a reviewer approves them — check pending_review_count to see how many are still held. Pass include: ['provenance'] for per-field source spans, or include: ['cells'] for the heavier cell-level payload.
When to use
talonic_get_runreportscompleted— or you want to read partial rows while it is stillprocessing.- You need the Spec's structured output for one document or the whole run.
When not to use
- Checking run progress — use
talonic_get_run. - Per-field provenance of a single value — pass
include: ['provenance']here, or usetalonic_field_values.
Parameters
| Parameter | Type | Description |
|---|---|---|
| run_id | string | From a `run_kind: 'run'` envelope, alone — or accompanying `pipeline_id` to scope that pipeline's results to one submission. |
| pipeline_id | string | From a `run_kind: 'pipeline'` envelope. Optionally pass `run_id` alongside it to scope results to one submission within the pipeline. |
| document_id | string | Restrict to one document. |
| include | string[] | `cells` and/or `provenance` — extra per-field detail; heavier payload. |
| limit | number | Page size (1–200, default 50). |
| cursor | string | Opaque cursor from `pagination.next_cursor`. |
Response shape
Fields
| Parameter | Type | Description |
|---|---|---|
| columns[].field_key | string | Stable field key, matches `data[].fields` keys. |
| columns[].display_name | string | Human-readable column label. |
| columns[].data_type | string | The field's data type (string, number, array, etc.). |
| data[].document_id | string | The document this row belongs to. |
| data[].filename | string | The document's filename. |
| data[].status | string | `complete`, `partial`, `error` or `processing` for this document's row. |
| data[].fields | object | `{ field_key: value }` — the clean values; held cells are `null`. |
| pagination | object | `total`, `limit`, `has_more`, `next_cursor`. |
| pending_review_count | number | Number of held (pending-review) cells on this page. |
Frequently asked questions
Why is a value null?+
Held (pending review) cells serialize as null until a reviewer approves them; `pending_review_count` tells you how many are held on the page.