Query Files

Deprecated

POST/api/v1/beta/files/query

Query files with flexible filtering and pagination.

Deprecated: Use GET /files instead for listing files with query parameters.

Args: request: The query request with filters and pagination project: Validated project from dependency db: Database session

Returns: Paginated response with files

ParametersExpand Collapse

organization_id: Optional[str]

project_id: Optional[str]

filter: Optional[Filter]

Filter parameters for file queries.

data_source_id: Optional[str]

Filter by data source ID

formatuuid

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

only_manually_uploaded: Optional[bool]

Filter only manually uploaded files (data_source_id is null)

project_id: Optional[str]

Filter by project ID

formatuuid

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.

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 FileQueryResponse: …

Response schema for paginated file queries in V2 API.

items: List[Item]

The list of items.

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')

next_page_token: Optional[str]

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_size: Optional[int]

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Query 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
)
response = client.files.query()
print(response.items)

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