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(ctx, pipelineID, query) (*PipelineDocumentGetStatusCountsResponse, error)

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 PipelineDocumentGetStatusCountsParams

DataSourceID param.Field[string]Optional

FileID param.Field[string]Optional

OnlyDirectUpload param.Field[bool]Optional

ProjectID param.Field[string]Optional

ReturnsExpand Collapse

type PipelineDocumentGetStatusCountsResponse struct{…}

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

Counts map[string, int64]

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

PipelineID string

ID of the pipeline the documents belong to.

formatuuid

TotalCount int64

Total number of documents counted.

DataSourceID stringOptional

Data source the counts were restricted to.

formatuuid

FileID stringOptional

File the counts were restricted to.

formatuuid

OnlyDirectUpload boolOptional

Whether only directly uploaded documents were counted.

Get Pipeline Document Status Counts

Go

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llama-parse-go"
  "github.com/run-llama/llama-parse-go/option"
)

func main() {
  client := llamacloud.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Pipelines.Documents.GetStatusCounts(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    llamacloud.PipelineDocumentGetStatusCountsParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.PipelineID)
}

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
}