List Folder Files

folders.files.list(, ) -> SyncArrayPage[FileListResponse]

get/v1/folders/{folder_id}/files

List paginated files associated with a data folder.

ParametersExpand Collapse

folder_id: str

The ID of the source in the format 'source-'

minLength43

maxLength43

after: Optional[str]

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

before: Optional[str]

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

include_content: Optional[bool]

Whether to include full file content

limit: Optional[int]

Maximum number of files to return

order: Optional[Literal["asc", "desc"]]

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

Accepts one of the following:

"asc"

"desc"

order_by: Optional[Literal["created_at"]]

Field to sort by

Accepts one of the following:

"created_at"

ReturnsExpand Collapse

class FileListResponse: …

Representation of a single FileMetadata

id: str

The human-friendly ID of the File

source_id: str

The unique identifier of the source associated with the document.

chunks_embedded: Optional[int]

Number of chunks that have been embedded.

content: Optional[str]

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

created_at: Optional[datetime]

The creation date of the file.

formatdate-time

error_message: Optional[str]

Optional error message if the file failed processing.

file_creation_date: Optional[str]

The creation date of the file.

file_last_modified_date: Optional[str]

The last modified date of the file.

file_name: Optional[str]

The name of the file.

file_path: Optional[str]

The path to the file.

file_size: Optional[int]

The size of the file in bytes.

file_type: Optional[str]

The type of the file (MIME type).

original_file_name: Optional[str]

The original name of the file as uploaded.

processing_status: Optional[Literal["pending", "parsing", "embedding", 2 more]]

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

Accepts one of the following:

"pending"

"parsing"

"embedding"

"completed"

"error"

total_chunks: Optional[int]

Total number of chunks for the file.

updated_at: Optional[datetime]

The update date of the file.

formatdate-time

List Folder Files

from letta_client import Letta

client = Letta(
    api_key="My API Key",
)
page = client.folders.files.list(
    folder_id="source-123e4567-e89b-42d3-8456-426614174000",
)
page = page.items[0]
print(page.id)

[
  {
    "id": "file-123e4567-e89b-12d3-a456-426614174000",
    "source_id": "source_id",
    "chunks_embedded": 0,
    "content": "content",
    "created_at": "2019-12-27T18:11:19.117Z",
    "error_message": "error_message",
    "file_creation_date": "file_creation_date",
    "file_last_modified_date": "file_last_modified_date",
    "file_name": "file_name",
    "file_path": "file_path",
    "file_size": 0,
    "file_type": "file_type",
    "original_file_name": "original_file_name",
    "processing_status": "pending",
    "total_chunks": 0,
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]

Returns Examples

[
  {
    "id": "file-123e4567-e89b-12d3-a456-426614174000",
    "source_id": "source_id",
    "chunks_embedded": 0,
    "content": "content",
    "created_at": "2019-12-27T18:11:19.117Z",
    "error_message": "error_message",
    "file_creation_date": "file_creation_date",
    "file_last_modified_date": "file_last_modified_date",
    "file_name": "file_name",
    "file_path": "file_path",
    "file_size": 0,
    "file_type": "file_type",
    "original_file_name": "original_file_name",
    "processing_status": "pending",
    "total_chunks": 0,
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]