List Files

files.list() -> SyncPaginatedCursor[FileListResponse]

GET/api/v1/beta/files

List files with optional filtering and pagination.

This endpoint retrieves files for the specified project with support for filtering by various criteria and cursor-based pagination.

ParametersExpand Collapse

external_file_id: Optional[str]

Filter by external file ID.

file_ids: Optional[SequenceNotStr[str]]

Filter by specific file IDs.

file_name: Optional[str]

Filter by file name (exact match).

order_by: Optional[str]

A comma-separated list of fields to order by, sorted in ascending order. Use 'field_name desc' to specify descending order.

organization_id: Optional[str]

page_size: Optional[int]

The maximum number of items to return. Defaults to 50, maximum is 1000.

maximum1000

minimum1

page_token: Optional[str]

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

project_id: Optional[str]

ReturnsExpand Collapse

class FileListResponse: …

Schema for a file in the v2 API.

id: str

Unique identifier

name: str

project_id: str

The ID of the project that the file belongs to

formatuuid

expires_at: Optional[datetime]

The expiration date for the file. Files past this date can be deleted.

formatdate-time

external_file_id: Optional[str]

The ID of the file in the external system

file_type: Optional[str]

File type (e.g. pdf, docx, etc.)

maxLength3000

minLength1

last_modified_at: Optional[datetime]

The last modified time of the file

formatdate-time

purpose: Optional[str]

The intended purpose of the file (e.g., 'user_data', 'parse', 'extract', 'split', 'classify', 'sheet', 'agent_app')

List 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.files.list()
page = page.items[0]
print(page.id)

{
  "items": [
    {
      "id": "id",
      "name": "x",
      "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "external_file_id": "external_file_id",
      "file_type": "x",
      "last_modified_at": "2019-12-27T18:11:19.117Z",
      "purpose": "purpose"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

{
  "items": [
    {
      "id": "id",
      "name": "x",
      "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "external_file_id": "external_file_id",
      "file_type": "x",
      "last_modified_at": "2019-12-27T18:11:19.117Z",
      "purpose": "purpose"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}