API Reference

Pipelines

Documents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Pipeline Document

Deprecated

client.pipelines.documents.get(stringdocumentID, DocumentGetParams { pipeline_id } params, RequestOptionsoptions?): CloudDocument { id, metadata, text, 4 more }

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

Return a single document for a pipeline.

ParametersExpand Collapse

documentID: string

params: DocumentGetParams { pipeline_id }

pipeline_id: string

ReturnsExpand Collapse

CloudDocument { id, metadata, text, 4 more }

Cloud document stored in S3.

id: string

metadata: Record<string, unknown>

text: string

excluded_embed_metadata_keys?: Array<string>

excluded_llm_metadata_keys?: Array<string>

page_positions?: Array<number> | null

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

status_metadata?: Record<string, unknown> | null

Get Pipeline Document

TypeScript

HTTP

TypeScript

Python

Java

Go

CLI Tool

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const cloudDocument = await client.pipelines.documents.get('document_id', {
  pipeline_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

console.log(cloudDocument.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"
  }
}