List Files

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.

Query ParametersExpand Collapse

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 (exact match).

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.

organization_id: optional string

page_size: optional number

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

maximum1000

minimum1

page_token: optional string

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

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

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.

List Files

curl https://api.cloud.llamaindex.ai/api/v1/beta/files \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

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