API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Archives

Create Archive

post/v1/archives/

List Archives

get/v1/archives/

Update Archive

patch/v1/archives/{archive_id}

Retrieve Archive

get/v1/archives/{archive_id}

Delete Archive

delete/v1/archives/{archive_id}

ModelsExpand Collapse

Archive = object { id, created_at, embedding_config, 7 more }

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

id: string

The human-friendly ID of the Archive

created_at: string

The creation date of the archive

formatdate-time

embedding_config: EmbeddingConfig { embedding_dim, embedding_endpoint_type, embedding_model, 7 more }

Embedding configuration for passages in this archive

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.

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: 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 archive

created_by_id: optional string

The id of the user that made this object.

description: optional string

A description of the archive

last_updated_by_id: optional string

The id of the user that made this object.

metadata: optional map[unknown]

Additional metadata

updated_at: optional string

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 = "native" or "tpuf" or "pinecone"

Supported vector database providers for archival memory

Accepts one of the following:

"native"

"tpuf"

"pinecone"

ArchivesPassages

Create Passage In Archive

post/v1/archives/{archive_id}/passages

Delete Passage From Archive

delete/v1/archives/{archive_id}/passages/{passage_id}