Skip to content
My Docs My Docs letta-sdk
  • Auto
  • Light
  • Dark
DiscordForumGitHubSign up
API Reference
View as Markdown
Copy Markdown
Open in Claude
Open in ChatGPT

Archives

Create Archive
archives.create(ArchiveCreateParams**kwargs) -> Archive
post/v1/archives/
List Archives
archives.list(ArchiveListParams**kwargs) -> SyncArrayPage[Archive]
get/v1/archives/
Modify Archive
archives.modify(strarchive_id, ArchiveModifyParams**kwargs) -> Archive
patch/v1/archives/{archive_id}
Get Archive By Id
archives.retrieve(strarchive_id) -> Archive
get/v1/archives/{archive_id}
Delete Archive
archives.delete(strarchive_id) -> Archive
delete/v1/archives/{archive_id}
ModelsExpand Collapse
class Archive: …

Representation of an archive - a collection of archival passages that can be shared between agents.

id: str

The human-friendly ID of the Archive

created_at: datetime

The creation date of the archive

formatdate-time
embedding_config: EmbeddingConfig

Embedding configuration for passages in this archive

embedding_dim: int

The dimension of the embedding.

embedding_endpoint_type: Literal["openai", "anthropic", "bedrock", 16 more]

The endpoint type for the model.

Accepts one of the following:
"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: str

The model for the embedding.

azure_deployment: Optional[str]

The Azure deployment for the model.

azure_endpoint: Optional[str]

The Azure endpoint for the model.

azure_version: Optional[str]

The Azure version for the model.

batch_size: Optional[int]

The maximum batch size for processing embeddings.

embedding_chunk_size: Optional[int]

The chunk size of the embedding.

embedding_endpoint: Optional[str]

The endpoint for the model (None if local).

handle: Optional[str]

The handle for this config, in the format provider/model-name.

name: str

The name of the archive

created_by_id: Optional[str]

The id of the user that made this object.

description: Optional[str]

A description of the archive

last_updated_by_id: Optional[str]

The id of the user that made this object.

metadata: Optional[Dict[str, object]]

Additional metadata

updated_at: Optional[datetime]

The timestamp when the object was last updated.

formatdate-time
vector_db_provider: Optional[VectorDBProvider]

The vector database provider used for this archive's passages

Accepts one of the following:
"native"
"tpuf"
"pinecone"
VectorDBProvider = Literal["native", "tpuf", "pinecone"]

Supported vector database providers for archival memory

Accepts one of the following:
"native"
"tpuf"
"pinecone"

ArchivesPassages

Delete Passage From Archive
archives.passages.delete(strpassage_id, PassageDeleteParams**kwargs)
delete/v1/archives/{archive_id}/passages/{passage_id}