Sources

Get File Metadata

Retrieve metadata for a specific file by its ID.

Path parameters

source_idstringRequired
file_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Query parameters

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.
idstring or nullformat: "^file-[a-fA-F0-9]{8}"

The human-friendly ID of the File

file_namestring or null
The name of the file.
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.
created_atstring or nullformat: "date-time"
The creation date of the file.
updated_atstring or nullformat: "date-time"
The update date of the file.
is_deletedboolean or nullDefaults to false
Whether this file is deleted or not.
contentstring or null

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