foldersFiles

List Files For Folder

List paginated files associated with a data folder.

Path parameters

folder_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Query parameters

beforestring or nullOptional
File ID cursor for pagination. Returns files that come before this file ID in the specified sort order
afterstring or nullOptional
File ID cursor for pagination. Returns files that come after this file ID in the specified sort order
limitinteger or nullOptionalDefaults to 1000
Maximum number of files to return
orderenumOptionalDefaults to desc
Sort order for files by creation time. 'asc' for oldest first, 'desc' for newest first
Allowed values:
order_by"created_at"OptionalDefaults to created_at
Field to sort by
include_contentbooleanOptionalDefaults to false
Whether to include full file content

Response

Successful Response
source_idstring
The unique identifier of the source associated with the document.
file_namestring or null
The name of the file.
original_file_namestring or null
The original name of the file as uploaded.
file_pathstring or null
The path to the file.
file_typestring or null

The type of the file (MIME type).

file_sizeinteger or null
The size of the file in bytes.
file_creation_datestring or null
The creation date of the file.
file_last_modified_datestring or null
The last modified date of the file.
processing_statusenum or null

The current processing status of the file (e.g. pending, parsing, embedding, completed, error).

Allowed values:
error_messagestring or null
Optional error message if the file failed processing.
total_chunksinteger or null
Total number of chunks for the file.
chunks_embeddedinteger or null
Number of chunks that have been embedded.
contentstring or null

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

idstring or nullformat: "^file-[a-fA-F0-9]{8}"

The human-friendly ID of the File

created_atstring or nullformat: "date-time"
The creation date of the file.
updated_atstring or nullformat: "date-time"
The update date of the file.

Errors