v36

latestOpenAPI 3.1.0raw.githubusercontent.com2025-10-091882241.2 MB
folders

List Folder Files

List paginated files associated with a data folder.

get/v1/folders/{folder_id}/files

Path parameters

folder_idstring required

Query parameters

beforestring nullable

File ID cursor for pagination. Returns files that come before this file ID in the specified sort order

File ID cursor for pagination. Returns files that come before this file ID in the specified sort order

afterstring nullable

File ID cursor for pagination. Returns files that come after this file ID in the specified sort order

File ID cursor for pagination. Returns files that come after this file ID in the specified sort order

limitinteger nullable

Maximum number of files to return

Maximum number of files to return

order'asc' | 'desc'

Sort order for files by creation time. 'asc' for oldest first, 'desc' for newest first

Sort order for files by creation time. 'asc' for oldest first, 'desc' for newest first

order_by'created_at'

Field to sort by

Field to sort by

include_contentboolean

Whether to include full file content

Whether to include full file content

Response

Successful Response

source_idstring required

The unique identifier of the source associated with the document.

file_namestring nullable

The name of the file.

original_file_namestring nullable

The original name of the file as uploaded.

file_pathstring nullable

The path to the file.

file_typestring nullable

The type of the file (MIME type).

file_sizeinteger nullable

The size of the file in bytes.

file_creation_datestring nullable

The creation date of the file.

file_last_modified_datestring nullable

The last modified date of the file.

processing_status'pending' | 'parsing' | 'embedding' | 'completed' | 'error'
error_messagestring nullable

Optional error message if the file failed processing.

total_chunksinteger nullable

Total number of chunks for the file.

chunks_embeddedinteger nullable

Number of chunks that have been embedded.

contentstring nullable

Optional full-text content of the file; only populated on demand due to its size.

idstring

The human-friendly ID of the File

created_atstring date-time nullable

The creation date of the file.

updated_atstring date-time nullable

The update date of the file.

Example response

[
  {
    "id": "file-123e4567-e89b-12d3-a456-426614174000"
  }
]