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

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

Body ParametersExpand Collapse

filter: optional object { data_source_id, external_file_id, file_ids, 3 more }

Filter parameters for file queries.

data_source_id: optional string

Filter by data source ID

formatuuid

external_file_id: optional string

Filter by external file ID

file_ids: optional array of string

Filter by specific file IDs

file_name: optional string

Filter by file name

only_manually_uploaded: optional boolean

Filter only manually uploaded files (data_source_id is null)

project_id: optional string

Filter by project ID

formatuuid

order_by: optional string

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

page_size: optional number

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 string

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

ReturnsExpand Collapse

items: array of object { id, name, project_id, 5 more }

The list of items.

id: string

Unique identifier

name: string

project_id: string

The ID of the project that the file belongs to

formatuuid

expires_at: optional string

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

formatdate-time

external_file_id: optional string

The ID of the file in the external system

file_type: optional string

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

maxLength3000

minLength1

last_modified_at: optional string

The last modified time of the file

formatdate-time

purpose: optional string

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

next_page_token: optional string

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 number

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

curl https://api.cloud.llamaindex.ai/api/v1/beta/files/query \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \
    -d '{}'

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