Find Files

beta.retrieval.find() -> SyncPaginatedCursorPost[RetrievalFindResponse]

POST/api/v1/retrieval/files/find

Search for files by name.

ParametersExpand Collapse

index_id: str

ID of the index to search within.

organization_id: Optional[str]

project_id: Optional[str]

file_name: Optional[str]

Exact file name to match.

file_name_contains: Optional[str]

Substring match on file name (case-insensitive).

page_size: Optional[int]

The maximum number of items to return. The service may return fewer than this value. If unspecified, a default page size will be used. The maximum value is typically 1000; values above this will be coerced to the maximum.

page_token: Optional[str]

A page token, received from a previous list call. Provide this to retrieve the subsequent page.

ReturnsExpand Collapse

class RetrievalFindResponse: …

A file returned by find.

file_id: str

ID of the file.

file_name: str

Display name of the file.

Find Files

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
)
page = client.beta.retrieval.find(
    index_id="idx-abc123",
)
page = page.items[0]
print(page.file_id)

{
  "items": [
    {
      "file_id": "file_id",
      "file_name": "file_name"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

{
  "items": [
    {
      "file_id": "file_id",
      "file_name": "file_name"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}