API Reference

Pipelines

Documents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Batch Pipeline Documents

Deprecated

$ llamacloud-prod pipelines:documents create

POST/api/v1/pipelines/{pipeline_id}/documents

Batch create documents for a pipeline.

ParametersExpand Collapse

--pipeline-id: string

--body: array of CloudDocumentCreate { metadata, text, id, 3 more }

ReturnsExpand Collapse

Response Create Batch Pipeline Documents Api V1 Pipelines Pipeline Id Documents Post: array of CloudDocument { id, metadata, text, 4 more }

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]

Create Batch Pipeline Documents

CLI Tool

HTTP

TypeScript

Python

Java

Go

CLI Tool

llamacloud-prod pipelines:documents create \
  --api-key 'My API Key' \
  --pipeline-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \
  --body '{metadata: {foo: bar}, text: text}'

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"
    }
  }
]