List Source Files

List paginated files associated with a data source.

Path parameters

source_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Query parameters

limitintegerOptionalDefaults to 1000
Number of files to return
afterstring or nullOptional
Pagination cursor to fetch the next set of results
include_contentbooleanOptionalDefaults to false
Whether to include full file content
check_status_updatesbooleanOptionalDefaults to true

Whether to check and update file processing status (from the vector db service). If False, will not fetch and update the status, which may lead to performance gains.

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