Get Pipeline
Retrieve a single pipeline run by ID: its name, status, the Spec it ran against, compiled phase count, and links to progress and the dashboard.
Retrieve a single pipeline run by its UUID. The response carries the run's name, status, the Spec it ran against, the number of compiled phases, and a links object. Use this to confirm a run exists and read its top-level state before polling progress or producing a data product.
The phase_count reflects how many phases the Spec rail compiled into for this run. A Spec with two resolution policies and a single validation checkpoint compiles to more phases than a bare extract-only Spec, so this count is a quick signal of how governed the run is. The schema.id ties the run back to the Spec it was launched from.
For phase-by-phase document counts and per-document error detail, use GET /v1/pipelines/{id}/progress. To read extracted rows, produce a data product from the run with POST /v1/pipelines/{id}/data-product. The run is tenant-scoped: a run that belongs to another organization returns 404 not_found. This endpoint requires an API key with the read scope.
/v1/pipelines/{id}Response
Response fields
Response
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Lease Agreement — 2024-09-14",
"status": "active",
"schema": { "id": "sch_uuid_1" },
"phase_count": 5,
"created_at": "2024-09-14T10:32:00.000Z",
"links": {
"self": "/v1/pipelines/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"progress": "/v1/pipelines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/progress",
"dashboard": "https://app.talonic.com/structure-pt/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}Errors
Error responses