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

pipelines.documents.create(strpipeline_id, DocumentCreateParams**kwargs) -> DocumentCreateResponse

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

Batch create documents for a pipeline.

ParametersExpand Collapse

pipeline_id: str

body: Iterable[CloudDocumentCreateParam]

metadata: Dict[str, object]

text: str

id: Optional[str]

excluded_embed_metadata_keys: Optional[List[str]]

excluded_llm_metadata_keys: Optional[List[str]]

page_positions: Optional[List[int]]

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

ReturnsExpand Collapse

List[CloudDocument]

id: str

metadata: Dict[str, object]

text: str

excluded_embed_metadata_keys: Optional[List[str]]

excluded_llm_metadata_keys: Optional[List[str]]

page_positions: Optional[List[int]]

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[Dict[str, object]]

Create Batch Pipeline Documents

Python

HTTP

TypeScript

Python

Java

Go

CLI Tool

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
cloud_documents = client.pipelines.documents.create(
    pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    body=[{
        "metadata": {
            "foo": "bar"
        },
        "text": "text",
    }],
)
print(cloud_documents)

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