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

client.pipelines.documents.getStatusCounts(stringpipelineID, DocumentGetStatusCountsParams { data_source_id, file_id, only_direct_upload, project_id } query?, RequestOptionsoptions?): DocumentGetStatusCountsResponse { counts, pipeline_id, total_count, 3 more }

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.

ParametersExpand Collapse

pipelineID: string

query: DocumentGetStatusCountsParams { data_source_id, file_id, only_direct_upload, project_id }

data_source_id?: string | null

file_id?: string | null

only_direct_upload?: boolean

project_id?: string | null

ReturnsExpand Collapse

DocumentGetStatusCountsResponse { counts, pipeline_id, total_count, 3 more }

Counts of the documents in a pipeline, grouped by ingestion status.

counts: Record<string, 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?: string | null

Data source the counts were restricted to.

formatuuid

file_id?: string | null

File the counts were restricted to.

formatuuid

only_direct_upload?: boolean

Whether only directly uploaded documents were counted.

Get Pipeline Document Status Counts

TypeScript

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.pipelines.documents.getStatusCounts(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.pipeline_id);

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
}