Pipeline Items

Retrieve, inspect, and track the status of documents and entities in your pipelines.

List Pipeline Items

GET /api/v1/pipelines/{pipeline_id}/items

Retrieve all items (submitted documents and their associated entities) in a pipeline. Use this to enumerate everything in a pipeline and check overall progress.

Parameters

Parameter	Type	Required	Description
`pipeline_id`	integer (path)	Yes	The pipeline to list items from
`skip`	integer (query)	No	Number of items to skip (default: 0)
`limit`	integer (query)	No	Maximum items to return (default: 100, max: 1000)
`sort_by`	string (query)	No	Column ID to sort by (e.g., `question.123`). Defaults to item ID
`sort_order`	string (query)	No	`asc` or `desc` (default: `asc`)

Response — 200 OK

Field	Type	Description
`pipeline_id`	integer	The pipeline identifier
`total_count`	integer	Total number of items in the pipeline
`items`	array	Array of pipeline item objects (see below)

Each item in the items array contains:

Field	Type	Description
`pipeline_id`	integer	The pipeline identifier
`pipeline_item_id`	integer	Unique identifier for the pipeline item
`entity_type`	string	One of: `organization`, `person`, `document`
`organization_id`	integer or null	Associated organization ID, if applicable
`person_id`	integer or null	Associated person ID, if applicable
`document_id`	integer or null	Associated document ID, if applicable
`values`	object	Column values keyed by column ID (see Values Object)

Errors

Status	Description
`400`	Invalid `sort_by` format or column not found
`401`	Authentication required
`403`	Authorization denied by policy chain
`404`	Pipeline not found

Get Pipeline Item Values

GET /api/v1/pipelines/{pipeline_id}/items/{pipeline_item_id}/values

Retrieve the extracted and enriched data for a specific pipeline item. This includes structured data pulled from the document, entity resolution results, and answers to your pipeline's qualifying questions.

Parameters

Parameter	Type	Required	Description
`pipeline_id`	integer (path)	Yes	The pipeline identifier
`pipeline_item_id`	integer (path)	Yes	The specific pipeline item to retrieve values for

Response — 200 OK

Field	Type	Description
`pipeline_id`	integer	The pipeline identifier
`pipeline_item_id`	integer	The pipeline item identifier
`entity_type`	string	One of: `organization`, `person`, `document`
`organization_id`	integer or null	Associated organization ID, if applicable
`person_id`	integer or null	Associated person ID, if applicable
`document_id`	integer or null	Associated document ID, if applicable
`values`	object	Column values keyed by column ID (see Values Object)

Errors

Status	Description
`400`	Item does not belong to the specified pipeline
`401`	Authentication required
`403`	Authorization denied by policy chain
`404`	Item not found

Get Pipeline Item Status

GET /api/v1/pipelines/{pipeline_id}/items/{pipeline_item_id}/status

Check the processing readiness of a specific pipeline item. Use this to poll for completion after submitting a document. The response reports whether each processing stage has finished, rather than a single status string.

Parameters

Parameter	Type	Required	Description
`pipeline_id`	integer (path)	Yes	The pipeline identifier
`pipeline_item_id`	integer (path)	Yes	The specific pipeline item to check

Response — 200 OK

Field	Type	Description
`pipeline_id`	integer	The pipeline identifier
`pipeline_item_id`	integer	The pipeline item identifier
`is_ready`	boolean	`true` when all three conditions below are met
`document_indexed`	boolean	Whether the submitted document has been fully indexed
`custom_questions_answered`	boolean	Whether all configured qualifying questions have reached a terminal state
`alphalens_entity_data_ready`	boolean	Whether all required AlphaLens entity data for configured columns is available

Errors

Status	Description
`400`	Item does not belong to the specified pipeline
`401`	Authentication required
`403`	Authorization denied by policy chain
`404`	Item not found

Values Object

The values field in item responses is a dictionary keyed by column ID (e.g., question.123 for a qualifying question, or an AlphaLens field path for entity data). Each value contains:

Field	Type	Description
`result`	array	List of extracted values (strings, numbers, etc.)
`category`	string	Value source: `alphalens_data`, `llm`, `llm_webbrowsing`, `llm_visual_engine`, or `formula`
`certainty_score`	integer or null	Confidence score (0–100). Null for entity data fields
`status`	string or null	Execution status for question columns: `pending`, `completed`, `no_answer`, `failed`, or `skipped`. Null for entity data fields
`references`	array	List of source reference URLs
`sync_status`	string or null	CRM sync status: `success`, `pending`, or `error`. Null if CRM sync is not configured
`sync_provider`	string or null	CRM provider name (e.g., `affinity`). Null if CRM sync is not configured
`last_synced_at`	string (ISO 8601) or null	Timestamp of last successful sync. Null if never synced
`sync_error`	string or null	Error message if the last sync attempt failed

Document Download

Organizations