File Operations

Beta

Index V2 is in beta. All endpoints are available under client.beta.* in the SDK and may change before GA.

File operations let you work with individual files inside an index. You can search for files by name, grep through their parsed content with regex, and read the full text of a file — all without needing to access the original documents.

These endpoints are available under client.beta.retrieval.* in the SDK.

Tip

MCP-compatible agents get the same capabilities through the findFilesInIndex, grepFileFromIndex, and readFileFromIndex tools of the LlamaParse MCP.

Find files

Find files by exact name or substring match.

Python

# Exact name match
results = await client.beta.retrieval.find(
    index_id="<your-index-id>",
    file_name="quarterly-report.pdf",
)

# Substring match (case-insensitive)
results = await client.beta.retrieval.find(
    index_id="<your-index-id>",
    file_name_contains="quarterly",
)

for f in results.items:
    print(f"{f.file_id}: {f.file_name}")

TypeScript

// Substring match
const results = await client.beta.retrieval.find({
  index_id: "<your-index-id>",
  file_name_contains: "quarterly",
});

for (const f of results.items) {
  console.log(`${f.file_id}: ${f.file_name}`);
}

Grep within a file

Search for a regex pattern within a file’s parsed text content. This is useful for finding specific terms, patterns, or sections within a document.

Python

results = await client.beta.retrieval.grep(
    index_id="<your-index-id>",
    file_id="<file-id>",
    pattern="revenue|profit",
    context_chars=100,  # characters of context around each match
)

for match in results.items:
    print(f"Offset {match.start_char}-{match.end_char}: {match.content}")

TypeScript

const results = await client.beta.retrieval.grep({
  index_id: "<your-index-id>",
  file_id: "<file-id>",
  pattern: "revenue|profit",
  context_chars: 100,
});

for (const match of results.items) {
  console.log(`Offset ${match.start_char}-${match.end_char}: ${match.content}`);
}

Grep parameters

Parameter	Type	Default	Description
index_id	string	required	ID of the index.
file_id	string	required	ID of the file to search within.
pattern	string	required	Regex pattern to match.
context_chars	int	null	Characters of context to include around each match.

Read a file

Read the parsed text content of a file. Supports pagination via offset and max_length for large documents.

Python

# Read the full file
result = await client.beta.retrieval.read(
    index_id="<your-index-id>",
    file_id="<file-id>",
)
print(result.content)

# Read a specific range
result = await client.beta.retrieval.read(
    index_id="<your-index-id>",
    file_id="<file-id>",
    offset=1000,
    max_length=5000,
)
print(result.content)

TypeScript

// Read the full file
const result = await client.beta.retrieval.read({
  index_id: "<your-index-id>",
  file_id: "<file-id>",
});
console.log(result.content);

// Read a specific range
const partial = await client.beta.retrieval.read({
  index_id: "<your-index-id>",
  file_id: "<file-id>",
  offset: 1000,
  max_length: 5000,
});
console.log(partial.content);

Read parameters

Parameter	Type	Default	Description
index_id	string	required	ID of the index.
file_id	string	required	ID of the file to read.
offset	int	0	Starting character offset.
max_length	int	null	Maximum characters to return from the offset. Returns the full file if omitted.