List Files

client.files.list(?, ?): PaginatedCursor<FileListResponse { id, name, project_id, 5 more } >

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

query: FileListParams { external_file_id, file_ids, file_name, 5 more }

external_file_id?: string | null

Filter by external file ID.

file_ids?: Array<string> | null

Filter by specific file IDs.

file_name?: string | null

Filter by file name (exact match).

order_by?: string | null

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

organization_id?: string | null

page_size?: number | null

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

maximum1000

minimum1

page_token?: string | null

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

project_id?: string | null

ReturnsExpand Collapse

FileListResponse { id, name, project_id, 5 more }

Schema for a file in the v2 API.

id: string

Unique identifier

name: string

project_id: string

The ID of the project that the file belongs to

formatuuid

expires_at?: string | null

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

formatdate-time

external_file_id?: string | null

The ID of the file in the external system

file_type?: string | null

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

maxLength3000

minLength1

last_modified_at?: string | null

The last modified time of the file

formatdate-time

purpose?: string | null

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

List Files

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const fileListResponse of client.files.list()) {
  console.log(fileListResponse.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
}