API Reference

Beta

Retrieval

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Read File

beta.retrieval.read(RetrievalReadParams**kwargs) -> RetrievalReadResponse

POST/api/v1/retrieval/files/read

Read the parsed text content of a specific file.

ParametersExpand Collapse

file_id: str

ID of the file to read.

index_id: str

ID of the index the file belongs to.

organization_id: Optional[str]

project_id: Optional[str]

max_length: Optional[int]

Maximum number of characters to read from the offset.

offset: Optional[int]

Starting character offset.

ReturnsExpand Collapse

class RetrievalReadResponse: …

File read result.

content: str

Parsed text content of the file.

Read File

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
)
response = client.beta.retrieval.read(
    file_id="file_id",
    index_id="idx-abc123",
)
print(response.content)

200 example

{
  "content": "content"
}

Returns Examples

200 example

{
  "content": "content"
}