API Reference

Pipelines

Documents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Pipeline Document

Deprecated

$ llamacloud-prod pipelines:documents get

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

Return a single document for a pipeline.

ParametersExpand Collapse

--pipeline-id: string

--document-id: string

ReturnsExpand Collapse

cloud_document: object { id, metadata, text, 4 more }

Cloud document stored in S3.

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]

Get Pipeline Document

CLI Tool

HTTP

TypeScript

Python

Java

Go

CLI Tool

llamacloud-prod pipelines:documents get \
  --api-key 'My API Key' \
  --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \
  --document-id document_id

200 example

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

Returns Examples

200 example

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