Paginated List Pipeline Documents

GET/api/v1/pipelines/{pipeline_id}/documents/paginated

Return a list of documents for a pipeline.

Path ParametersExpand Collapse

pipeline_id: string

Query ParametersExpand Collapse

file_id: optional string

limit: optional number

only_api_data_source_documents: optional boolean

only_direct_upload: optional boolean

skip: optional number

status_refresh_policy: optional "cached" or "ttl"

Accepts one of the following:

"cached"

"ttl"

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

documents: array of CloudDocument { id, metadata, text, 4 more }

The documents to list

id: string

metadata: map[unknown]

text: string

excluded_embed_metadata_keys: optional array of string

excluded_llm_metadata_keys: optional array of string

page_positions: optional array of number

indices in the CloudDocument.text where a new page begins. e.g. Second page starts at index specified by page_positions[1].

status_metadata: optional map[unknown]

limit: number

The limit of the documents

offset: number

The offset of the documents

total_count: number

The total number of documents

Paginated List Pipeline Documents

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

{
  "documents": [
    {
      "id": "id",
      "metadata": {
        "foo": "bar"
      },
      "text": "text",
      "excluded_embed_metadata_keys": [
        "string"
      ],
      "excluded_llm_metadata_keys": [
        "string"
      ],
      "page_positions": [
        0
      ],
      "status_metadata": {
        "foo": "bar"
      }
    }
  ],
  "limit": 0,
  "offset": 0,
  "total_count": 0
}

Returns Examples

{
  "documents": [
    {
      "id": "id",
      "metadata": {
        "foo": "bar"
      },
      "text": "text",
      "excluded_embed_metadata_keys": [
        "string"
      ],
      "excluded_llm_metadata_keys": [
        "string"
      ],
      "page_positions": [
        0
      ],
      "status_metadata": {
        "foo": "bar"
      }
    }
  ],
  "limit": 0,
  "offset": 0,
  "total_count": 0
}