Pipelines

Get Pipeline Document Status Counts

Changed on

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.

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

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/pipelines/{pipeline_id}/documents/status-counts
  • Auth: HTTP bearer

Path parameters

pipeline_idstring uuid required

Query parameters

file_idstring uuid nullable
data_source_idstring uuid nullable
only_direct_uploadboolean
project_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

countsobject required

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

total_countinteger required

Total number of documents counted.

pipeline_idstring uuid required

ID of the pipeline the documents belong to.

file_idstring uuid nullable

File the counts were restricted to.

data_source_idstring uuid nullable

Data source the counts were restricted to.

only_direct_uploadboolean

Whether only directly uploaded documents were counted.

Changes