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

DocumentGetStatusCountsResponse pipelines().documents().getStatusCounts(DocumentGetStatusCountsParamsparams = DocumentGetStatusCountsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

DocumentGetStatusCountsParams params

Optional<String> pipelineId

Optional<String> dataSourceId

Optional<String> fileId

Optional<Boolean> onlyDirectUpload

Optional<String> projectId

ReturnsExpand Collapse

class DocumentGetStatusCountsResponse:

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

Counts counts

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

String pipelineId

ID of the pipeline the documents belong to.

formatuuid

long totalCount

Total number of documents counted.

Optional<String> dataSourceId

Data source the counts were restricted to.

formatuuid

Optional<String> fileId

File the counts were restricted to.

formatuuid

Optional<Boolean> onlyDirectUpload

Whether only directly uploaded documents were counted.

Get Pipeline Document Status Counts

Java

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

package ai.llamaindex.llamacloud.example;

import ai.llamaindex.llamacloud.client.LlamaCloudClient;
import ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;
import ai.llamaindex.llamacloud.models.pipelines.documents.DocumentGetStatusCountsParams;
import ai.llamaindex.llamacloud.models.pipelines.documents.DocumentGetStatusCountsResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        DocumentGetStatusCountsResponse response = client.pipelines().documents().getStatusCounts("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
    }
}

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
}