Files

Upload File To Folder

POST/v1/folders/{folder_id}/upload

List Files For Folder

GET/v1/folders/{folder_id}/files

Retrieve File

GET/v1/folders/{folder_id}/files/{file_id}

Delete File From Folder

DELETE/v1/folders/{folder_id}/{file_id}

ModelsExpand Collapse

FileUploadResponse object { id, source_id, chunks_embedded, 13 more }

Representation of a single FileMetadata

id: string

The human-friendly ID of the File

Deprecatedsource_id: string

Deprecated: Use folder_id field instead. The unique identifier of the source associated with the document.

chunks_embedded: optional number

Number of chunks that have been embedded.

content: optional string

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

created_at: optional string

The creation date of the file.

formatdate-time

error_message: optional string

Optional error message if the file failed processing.

file_creation_date: optional string

The creation date of the file.

file_last_modified_date: optional string

The last modified date of the file.

file_name: optional string

The name of the file.

file_path: optional string

The path to the file.

file_size: optional number

The size of the file in bytes.

file_type: optional string

The type of the file (MIME type).

original_file_name: optional string

The original name of the file as uploaded.

processing_status: optional "pending" or "parsing" or "embedding" or 2 more

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

One of the following:

"pending"

"parsing"

"embedding"

"completed"

"error"

total_chunks: optional number

Total number of chunks for the file.

updated_at: optional string

The update date of the file.

formatdate-time

FileListResponse object { id, source_id, chunks_embedded, 13 more }

Representation of a single FileMetadata

id: string

The human-friendly ID of the File

Deprecatedsource_id: string

Deprecated: Use folder_id field instead. The unique identifier of the source associated with the document.

chunks_embedded: optional number

Number of chunks that have been embedded.

content: optional string

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

created_at: optional string

The creation date of the file.

formatdate-time

error_message: optional string

Optional error message if the file failed processing.

file_creation_date: optional string

The creation date of the file.

file_last_modified_date: optional string

The last modified date of the file.

file_name: optional string

The name of the file.

file_path: optional string

The path to the file.

file_size: optional number

The size of the file in bytes.

file_type: optional string

The type of the file (MIME type).

original_file_name: optional string

The original name of the file as uploaded.

processing_status: optional "pending" or "parsing" or "embedding" or 2 more

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

One of the following:

"pending"

"parsing"

"embedding"

"completed"

"error"

total_chunks: optional number

Total number of chunks for the file.

updated_at: optional string

The update date of the file.

formatdate-time

FileRetrieveResponse object { id, source_id, chunks_embedded, 13 more }

Representation of a single FileMetadata

id: string

The human-friendly ID of the File

Deprecatedsource_id: string

Deprecated: Use folder_id field instead. The unique identifier of the source associated with the document.

chunks_embedded: optional number

Number of chunks that have been embedded.

content: optional string

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

created_at: optional string

The creation date of the file.

formatdate-time

error_message: optional string

Optional error message if the file failed processing.

file_creation_date: optional string

The creation date of the file.

file_last_modified_date: optional string

The last modified date of the file.

file_name: optional string

The name of the file.

file_path: optional string

The path to the file.

file_size: optional number

The size of the file in bytes.

file_type: optional string

The type of the file (MIME type).

original_file_name: optional string

The original name of the file as uploaded.

processing_status: optional "pending" or "parsing" or "embedding" or 2 more

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

One of the following:

"pending"

"parsing"

"embedding"

"completed"

"error"

total_chunks: optional number

Total number of chunks for the file.

updated_at: optional string

The update date of the file.

formatdate-time