# Folders ## Retrieve Folder **get** `/v1/folders/{folder_id}` Get a folder by ID ### Path Parameters - `folder_id: string` The ID of the source in the format 'source-' ### Returns - `Folder object { id, embedding_config, name, 7 more }` Representation of a folder, which is a collection of files and passages. - `id: string` The human-friendly ID of the Source - `embedding_config: EmbeddingConfig` The embedding configuration used by the folder. - `embedding_dim: number` The dimension of the embedding. - `embedding_endpoint_type: "openai" or "anthropic" or "bedrock" or 16 more` The endpoint type for the model. - `"openai"` - `"anthropic"` - `"bedrock"` - `"google_ai"` - `"google_vertex"` - `"azure"` - `"groq"` - `"ollama"` - `"webui"` - `"webui-legacy"` - `"lmstudio"` - `"lmstudio-legacy"` - `"llamacpp"` - `"koboldcpp"` - `"vllm"` - `"hugging-face"` - `"mistral"` - `"together"` - `"pinecone"` - `embedding_model: string` The model for the embedding. - `azure_deployment: optional string` The Azure deployment for the model. - `azure_endpoint: optional string` The Azure endpoint for the model. - `azure_version: optional string` The Azure version for the model. - `batch_size: optional number` The maximum batch size for processing embeddings. - `embedding_chunk_size: optional number` The chunk size of the embedding. - `embedding_endpoint: optional string` The endpoint for the model (`None` if local). - `handle: optional string` The handle for this config, in the format provider/model-name. - `name: string` The name of the folder. - `created_at: optional string` The timestamp when the folder was created. - `created_by_id: optional string` The id of the user that made this Tool. - `description: optional string` The description of the folder. - `instructions: optional string` Instructions for how to use the folder. - `last_updated_by_id: optional string` The id of the user that made this Tool. - `metadata: optional map[unknown]` Metadata associated with the folder. - `updated_at: optional string` The timestamp when the folder was last updated. ### Example ```http curl https://api.letta.com/v1/folders/$FOLDER_ID \ -H "Authorization: Bearer $LETTA_API_KEY" ``` #### Response ```json { "id": "source-123e4567-e89b-12d3-a456-426614174000", "embedding_config": { "embedding_dim": 0, "embedding_endpoint_type": "openai", "embedding_model": "embedding_model", "azure_deployment": "azure_deployment", "azure_endpoint": "azure_endpoint", "azure_version": "azure_version", "batch_size": 0, "embedding_chunk_size": 0, "embedding_endpoint": "embedding_endpoint", "handle": "handle" }, "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "created_by_id": "created_by_id", "description": "description", "instructions": "instructions", "last_updated_by_id": "last_updated_by_id", "metadata": { "foo": "bar" }, "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Update Folder **patch** `/v1/folders/{folder_id}` Update the name or documentation of an existing data folder. ### Path Parameters - `folder_id: string` The ID of the source in the format 'source-' ### Body Parameters - `description: optional string` The description of the source. - `embedding_config: optional EmbeddingConfig` Configuration for embedding model connection and processing parameters. - `embedding_dim: number` The dimension of the embedding. - `embedding_endpoint_type: "openai" or "anthropic" or "bedrock" or 16 more` The endpoint type for the model. - `"openai"` - `"anthropic"` - `"bedrock"` - `"google_ai"` - `"google_vertex"` - `"azure"` - `"groq"` - `"ollama"` - `"webui"` - `"webui-legacy"` - `"lmstudio"` - `"lmstudio-legacy"` - `"llamacpp"` - `"koboldcpp"` - `"vllm"` - `"hugging-face"` - `"mistral"` - `"together"` - `"pinecone"` - `embedding_model: string` The model for the embedding. - `azure_deployment: optional string` The Azure deployment for the model. - `azure_endpoint: optional string` The Azure endpoint for the model. - `azure_version: optional string` The Azure version for the model. - `batch_size: optional number` The maximum batch size for processing embeddings. - `embedding_chunk_size: optional number` The chunk size of the embedding. - `embedding_endpoint: optional string` The endpoint for the model (`None` if local). - `handle: optional string` The handle for this config, in the format provider/model-name. - `instructions: optional string` Instructions for how to use the source. - `metadata: optional map[unknown]` Metadata associated with the source. - `name: optional string` The name of the source. ### Returns - `Folder object { id, embedding_config, name, 7 more }` Representation of a folder, which is a collection of files and passages. - `id: string` The human-friendly ID of the Source - `embedding_config: EmbeddingConfig` The embedding configuration used by the folder. - `embedding_dim: number` The dimension of the embedding. - `embedding_endpoint_type: "openai" or "anthropic" or "bedrock" or 16 more` The endpoint type for the model. - `"openai"` - `"anthropic"` - `"bedrock"` - `"google_ai"` - `"google_vertex"` - `"azure"` - `"groq"` - `"ollama"` - `"webui"` - `"webui-legacy"` - `"lmstudio"` - `"lmstudio-legacy"` - `"llamacpp"` - `"koboldcpp"` - `"vllm"` - `"hugging-face"` - `"mistral"` - `"together"` - `"pinecone"` - `embedding_model: string` The model for the embedding. - `azure_deployment: optional string` The Azure deployment for the model. - `azure_endpoint: optional string` The Azure endpoint for the model. - `azure_version: optional string` The Azure version for the model. - `batch_size: optional number` The maximum batch size for processing embeddings. - `embedding_chunk_size: optional number` The chunk size of the embedding. - `embedding_endpoint: optional string` The endpoint for the model (`None` if local). - `handle: optional string` The handle for this config, in the format provider/model-name. - `name: string` The name of the folder. - `created_at: optional string` The timestamp when the folder was created. - `created_by_id: optional string` The id of the user that made this Tool. - `description: optional string` The description of the folder. - `instructions: optional string` Instructions for how to use the folder. - `last_updated_by_id: optional string` The id of the user that made this Tool. - `metadata: optional map[unknown]` Metadata associated with the folder. - `updated_at: optional string` The timestamp when the folder was last updated. ### Example ```http curl https://api.letta.com/v1/folders/$FOLDER_ID \ -X PATCH \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $LETTA_API_KEY" \ -d '{}' ``` #### Response ```json { "id": "source-123e4567-e89b-12d3-a456-426614174000", "embedding_config": { "embedding_dim": 0, "embedding_endpoint_type": "openai", "embedding_model": "embedding_model", "azure_deployment": "azure_deployment", "azure_endpoint": "azure_endpoint", "azure_version": "azure_version", "batch_size": 0, "embedding_chunk_size": 0, "embedding_endpoint": "embedding_endpoint", "handle": "handle" }, "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "created_by_id": "created_by_id", "description": "description", "instructions": "instructions", "last_updated_by_id": "last_updated_by_id", "metadata": { "foo": "bar" }, "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Delete Folder **delete** `/v1/folders/{folder_id}` Delete a data folder. ### Path Parameters - `folder_id: string` The ID of the source in the format 'source-' ### Example ```http curl https://api.letta.com/v1/folders/$FOLDER_ID \ -X DELETE \ -H "Authorization: Bearer $LETTA_API_KEY" ``` #### Response ```json {} ``` ## List Folders **get** `/v1/folders/` List all data folders created by a user. ### Query Parameters - `after: optional string` Cursor for pagination (source ID). Returns results relative to this ID in the specified sort order. Expected format: 'source-' - `before: optional string` Cursor for pagination (source ID). Returns results relative to this ID in the specified sort order. Expected format: 'source-' - `limit: optional number` Maximum number of folders to return - `name: optional string` Folder name to filter by - `order: optional "asc" or "desc"` Sort order for folders by creation time. 'asc' for oldest first, 'desc' for newest first - `"asc"` - `"desc"` - `order_by: optional "created_at"` Field to sort by - `"created_at"` ### Returns - `id: string` The human-friendly ID of the Source - `embedding_config: EmbeddingConfig` The embedding configuration used by the folder. - `embedding_dim: number` The dimension of the embedding. - `embedding_endpoint_type: "openai" or "anthropic" or "bedrock" or 16 more` The endpoint type for the model. - `"openai"` - `"anthropic"` - `"bedrock"` - `"google_ai"` - `"google_vertex"` - `"azure"` - `"groq"` - `"ollama"` - `"webui"` - `"webui-legacy"` - `"lmstudio"` - `"lmstudio-legacy"` - `"llamacpp"` - `"koboldcpp"` - `"vllm"` - `"hugging-face"` - `"mistral"` - `"together"` - `"pinecone"` - `embedding_model: string` The model for the embedding. - `azure_deployment: optional string` The Azure deployment for the model. - `azure_endpoint: optional string` The Azure endpoint for the model. - `azure_version: optional string` The Azure version for the model. - `batch_size: optional number` The maximum batch size for processing embeddings. - `embedding_chunk_size: optional number` The chunk size of the embedding. - `embedding_endpoint: optional string` The endpoint for the model (`None` if local). - `handle: optional string` The handle for this config, in the format provider/model-name. - `name: string` The name of the folder. - `created_at: optional string` The timestamp when the folder was created. - `created_by_id: optional string` The id of the user that made this Tool. - `description: optional string` The description of the folder. - `instructions: optional string` Instructions for how to use the folder. - `last_updated_by_id: optional string` The id of the user that made this Tool. - `metadata: optional map[unknown]` Metadata associated with the folder. - `updated_at: optional string` The timestamp when the folder was last updated. ### Example ```http curl https://api.letta.com/v1/folders/ \ -H "Authorization: Bearer $LETTA_API_KEY" ``` #### Response ```json [ { "id": "source-123e4567-e89b-12d3-a456-426614174000", "embedding_config": { "embedding_dim": 0, "embedding_endpoint_type": "openai", "embedding_model": "embedding_model", "azure_deployment": "azure_deployment", "azure_endpoint": "azure_endpoint", "azure_version": "azure_version", "batch_size": 0, "embedding_chunk_size": 0, "embedding_endpoint": "embedding_endpoint", "handle": "handle" }, "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "created_by_id": "created_by_id", "description": "description", "instructions": "instructions", "last_updated_by_id": "last_updated_by_id", "metadata": { "foo": "bar" }, "updated_at": "2019-12-27T18:11:19.117Z" } ] ``` ## Create Folder **post** `/v1/folders/` Create a new data folder. ### Body Parameters - `name: string` The name of the source. - `description: optional string` The description of the source. - `embedding: optional string` The handle for the embedding config used by the source. - `embedding_chunk_size: optional number` The chunk size of the embedding. - `embedding_config: optional EmbeddingConfig` Configuration for embedding model connection and processing parameters. - `embedding_dim: number` The dimension of the embedding. - `embedding_endpoint_type: "openai" or "anthropic" or "bedrock" or 16 more` The endpoint type for the model. - `"openai"` - `"anthropic"` - `"bedrock"` - `"google_ai"` - `"google_vertex"` - `"azure"` - `"groq"` - `"ollama"` - `"webui"` - `"webui-legacy"` - `"lmstudio"` - `"lmstudio-legacy"` - `"llamacpp"` - `"koboldcpp"` - `"vllm"` - `"hugging-face"` - `"mistral"` - `"together"` - `"pinecone"` - `embedding_model: string` The model for the embedding. - `azure_deployment: optional string` The Azure deployment for the model. - `azure_endpoint: optional string` The Azure endpoint for the model. - `azure_version: optional string` The Azure version for the model. - `batch_size: optional number` The maximum batch size for processing embeddings. - `embedding_chunk_size: optional number` The chunk size of the embedding. - `embedding_endpoint: optional string` The endpoint for the model (`None` if local). - `handle: optional string` The handle for this config, in the format provider/model-name. - `instructions: optional string` Instructions for how to use the source. - `metadata: optional map[unknown]` Metadata associated with the source. ### Returns - `Folder object { id, embedding_config, name, 7 more }` Representation of a folder, which is a collection of files and passages. - `id: string` The human-friendly ID of the Source - `embedding_config: EmbeddingConfig` The embedding configuration used by the folder. - `embedding_dim: number` The dimension of the embedding. - `embedding_endpoint_type: "openai" or "anthropic" or "bedrock" or 16 more` The endpoint type for the model. - `"openai"` - `"anthropic"` - `"bedrock"` - `"google_ai"` - `"google_vertex"` - `"azure"` - `"groq"` - `"ollama"` - `"webui"` - `"webui-legacy"` - `"lmstudio"` - `"lmstudio-legacy"` - `"llamacpp"` - `"koboldcpp"` - `"vllm"` - `"hugging-face"` - `"mistral"` - `"together"` - `"pinecone"` - `embedding_model: string` The model for the embedding. - `azure_deployment: optional string` The Azure deployment for the model. - `azure_endpoint: optional string` The Azure endpoint for the model. - `azure_version: optional string` The Azure version for the model. - `batch_size: optional number` The maximum batch size for processing embeddings. - `embedding_chunk_size: optional number` The chunk size of the embedding. - `embedding_endpoint: optional string` The endpoint for the model (`None` if local). - `handle: optional string` The handle for this config, in the format provider/model-name. - `name: string` The name of the folder. - `created_at: optional string` The timestamp when the folder was created. - `created_by_id: optional string` The id of the user that made this Tool. - `description: optional string` The description of the folder. - `instructions: optional string` Instructions for how to use the folder. - `last_updated_by_id: optional string` The id of the user that made this Tool. - `metadata: optional map[unknown]` Metadata associated with the folder. - `updated_at: optional string` The timestamp when the folder was last updated. ### Example ```http curl https://api.letta.com/v1/folders/ \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $LETTA_API_KEY" \ -d '{ "name": "name" }' ``` #### Response ```json { "id": "source-123e4567-e89b-12d3-a456-426614174000", "embedding_config": { "embedding_dim": 0, "embedding_endpoint_type": "openai", "embedding_model": "embedding_model", "azure_deployment": "azure_deployment", "azure_endpoint": "azure_endpoint", "azure_version": "azure_version", "batch_size": 0, "embedding_chunk_size": 0, "embedding_endpoint": "embedding_endpoint", "handle": "handle" }, "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "created_by_id": "created_by_id", "description": "description", "instructions": "instructions", "last_updated_by_id": "last_updated_by_id", "metadata": { "foo": "bar" }, "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Domain Types ### Folder - `Folder object { id, embedding_config, name, 7 more }` Representation of a folder, which is a collection of files and passages. - `id: string` The human-friendly ID of the Source - `embedding_config: EmbeddingConfig` The embedding configuration used by the folder. - `embedding_dim: number` The dimension of the embedding. - `embedding_endpoint_type: "openai" or "anthropic" or "bedrock" or 16 more` The endpoint type for the model. - `"openai"` - `"anthropic"` - `"bedrock"` - `"google_ai"` - `"google_vertex"` - `"azure"` - `"groq"` - `"ollama"` - `"webui"` - `"webui-legacy"` - `"lmstudio"` - `"lmstudio-legacy"` - `"llamacpp"` - `"koboldcpp"` - `"vllm"` - `"hugging-face"` - `"mistral"` - `"together"` - `"pinecone"` - `embedding_model: string` The model for the embedding. - `azure_deployment: optional string` The Azure deployment for the model. - `azure_endpoint: optional string` The Azure endpoint for the model. - `azure_version: optional string` The Azure version for the model. - `batch_size: optional number` The maximum batch size for processing embeddings. - `embedding_chunk_size: optional number` The chunk size of the embedding. - `embedding_endpoint: optional string` The endpoint for the model (`None` if local). - `handle: optional string` The handle for this config, in the format provider/model-name. - `name: string` The name of the folder. - `created_at: optional string` The timestamp when the folder was created. - `created_by_id: optional string` The id of the user that made this Tool. - `description: optional string` The description of the folder. - `instructions: optional string` Instructions for how to use the folder. - `last_updated_by_id: optional string` The id of the user that made this Tool. - `metadata: optional map[unknown]` Metadata associated with the folder. - `updated_at: optional string` The timestamp when the folder was last updated. ### Folder Delete Response - `FolderDeleteResponse = unknown` # Files ## Upload File To Folder **post** `/v1/folders/{folder_id}/upload` Upload a file to a data folder. ### Path Parameters - `folder_id: string` The ID of the source in the format 'source-' ### Query Parameters - `duplicate_handling: optional "skip" or "error" or "suffix" or "replace"` How to handle duplicate filenames - `"skip"` - `"error"` - `"suffix"` - `"replace"` - `name: optional string` Optional custom name to override the uploaded file's name ### Returns - `id: string` The human-friendly ID of the File - `source_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. - `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). - `"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. ### Example ```http curl https://api.letta.com/v1/folders/$FOLDER_ID/upload \ -H 'Content-Type: multipart/form-data' \ -H "Authorization: Bearer $LETTA_API_KEY" \ -F 'file=@/path/to/file' ``` #### Response ```json { "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" } ``` ## List Files For Folder **get** `/v1/folders/{folder_id}/files` List paginated files associated with a data folder. ### Path Parameters - `folder_id: string` The ID of the source in the format 'source-' ### Query Parameters - `after: optional string` Cursor for pagination (file ID). Returns results relative to this ID in the specified sort order. Expected format: 'file-' - `before: optional string` Cursor for pagination (file ID). Returns results relative to this ID in the specified sort order. Expected format: 'file-' - `include_content: optional boolean` Whether to include full file content - `limit: optional number` Maximum number of files to return - `order: optional "asc" or "desc"` Sort order for files by creation time. 'asc' for oldest first, 'desc' for newest first - `"asc"` - `"desc"` - `order_by: optional "created_at"` Field to sort by - `"created_at"` ### Returns - `id: string` The human-friendly ID of the File - `source_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. - `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). - `"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. ### Example ```http curl https://api.letta.com/v1/folders/$FOLDER_ID/files \ -H "Authorization: Bearer $LETTA_API_KEY" ``` #### Response ```json [ { "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" } ] ``` ## Retrieve File **get** `/v1/folders/{folder_id}/files/{file_id}` Retrieve a file from a folder by ID. ### Path Parameters - `folder_id: string` The ID of the source in the format 'source-' - `file_id: string` The ID of the file in the format 'file-' ### Query Parameters - `include_content: optional boolean` Whether to include full file content ### Returns - `id: string` The human-friendly ID of the File - `source_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. - `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). - `"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. ### Example ```http curl https://api.letta.com/v1/folders/$FOLDER_ID/files/$FILE_ID \ -H "Authorization: Bearer $LETTA_API_KEY" ``` #### Response ```json { "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" } ``` ## Delete File From Folder **delete** `/v1/folders/{folder_id}/{file_id}` Delete a file from a folder. ### Path Parameters - `folder_id: string` The ID of the source in the format 'source-' - `file_id: string` The ID of the file in the format 'file-' ### Example ```http curl https://api.letta.com/v1/folders/$FOLDER_ID/$FILE_ID \ -X DELETE \ -H "Authorization: Bearer $LETTA_API_KEY" ``` ## Domain Types ### File Upload Response - `FileUploadResponse object { id, source_id, chunks_embedded, 13 more }` Representation of a single FileMetadata - `id: string` The human-friendly ID of the File - `source_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. - `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). - `"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. ### File List Response - `FileListResponse object { id, source_id, chunks_embedded, 13 more }` Representation of a single FileMetadata - `id: string` The human-friendly ID of the File - `source_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. - `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). - `"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. ### File Retrieve Response - `FileRetrieveResponse object { id, source_id, chunks_embedded, 13 more }` Representation of a single FileMetadata - `id: string` The human-friendly ID of the File - `source_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. - `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). - `"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. # Agents ## List Agents For Folder **get** `/v1/folders/{folder_id}/agents` Get all agent IDs that have the specified folder attached. ### Path Parameters - `folder_id: string` The ID of the source in the format 'source-' ### Query Parameters - `after: optional string` Cursor for pagination (agent ID). Returns results relative to this ID in the specified sort order. Expected format: 'agent-' - `before: optional string` Cursor for pagination (agent ID). Returns results relative to this ID in the specified sort order. Expected format: 'agent-' - `limit: optional number` Maximum number of agents to return - `order: optional "asc" or "desc"` Sort order for agents by creation time. 'asc' for oldest first, 'desc' for newest first - `"asc"` - `"desc"` - `order_by: optional "created_at"` Field to sort by - `"created_at"` ### Example ```http curl https://api.letta.com/v1/folders/$FOLDER_ID/agents \ -H "Authorization: Bearer $LETTA_API_KEY" ``` #### Response ```json [ "string" ] ``` ## Domain Types ### Agent List Response - `AgentListResponse = array of string`