API Reference

Pipelines

Documents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Pipeline Document Status Counts

Deprecated

GET/api/v1/pipelines/{pipeline_id}/documents/status-counts

Count the documents in a pipeline, grouped by ingestion status.

Counts reflect each document’s last recorded status rather than a freshly computed one, so a document that changed status in the last few moments may still be counted under its previous one. Use GET /pipelines/{pipeline_id}/documents/{document_id}/status when a single document’s status has to be up to the moment.

Path ParametersExpand Collapse

pipeline_id: string

Query ParametersExpand Collapse

data_source_id: optional string

file_id: optional string

only_direct_upload: optional boolean

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

counts: map[number]

Number of documents per ingestion status; every status is present.

pipeline_id: string

ID of the pipeline the documents belong to.

formatuuid

total_count: number

Total number of documents counted.

data_source_id: optional string

Data source the counts were restricted to.

formatuuid

file_id: optional string

File the counts were restricted to.

formatuuid

only_direct_upload: optional boolean

Whether only directly uploaded documents were counted.

Get Pipeline Document Status Counts

HTTP

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

curl https://api.cloud.llamaindex.ai/api/v1/pipelines/$PIPELINE_ID/documents/status-counts \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

200 example

{
  "counts": {
    "foo": 0
  },
  "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "total_count": 0,
  "data_source_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "only_direct_upload": true
}

Returns Examples

200 example

{
  "counts": {
    "foo": 0
  },
  "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "total_count": 0,
  "data_source_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "only_direct_upload": true
}