1007 lines
37 KiB
YAML
1007 lines
37 KiB
YAML
instances:
|
|
- url: https://letta.docs.buildwithfern.com
|
|
custom-domain: https://docs.letta.com
|
|
title: Letta
|
|
|
|
default-language: typescript
|
|
|
|
experimental:
|
|
openapi-parser-v3: true
|
|
|
|
tabs:
|
|
docs:
|
|
display-name: Documentation
|
|
slug: documentation
|
|
ade:
|
|
display-name: ADE Guide
|
|
slug: ade
|
|
cloud:
|
|
display-name: Letta Cloud
|
|
skip-slug: true
|
|
selfhosted:
|
|
display-name: Self-Hosting
|
|
skip-slug: true
|
|
ref:
|
|
display-name: API Reference
|
|
skip-slug: true
|
|
cookbooks:
|
|
display-name: Cookbooks
|
|
icon: fa-sharp fa-light fa-books
|
|
skip-slug: true
|
|
github:
|
|
display-name: GitHub
|
|
icon: fa-brands fa-github
|
|
href: https://github.com/letta-ai/letta
|
|
discord:
|
|
display-name: Discord
|
|
icon: fa-brands fa-discord
|
|
href: https://discord.gg/letta
|
|
community:
|
|
display-name: Developer Community
|
|
icon: fa-sharp fa-light fa-user-astronaut
|
|
skip-slug: true
|
|
install:
|
|
display-name: Download
|
|
icon: fa-sharp fa-light fa-download
|
|
skip-slug: true
|
|
showcase:
|
|
display-name: Examples
|
|
skip-slug: true
|
|
evals:
|
|
display-name: Evals
|
|
slug: evals
|
|
landing-page:
|
|
page: home
|
|
path: pages/index.mdx
|
|
|
|
navigation:
|
|
- tab: docs
|
|
layout:
|
|
- link: Chat on Discord
|
|
icon: fa-brands fa-discord
|
|
href: https://discord.gg/letta
|
|
- link: Developer Forum
|
|
icon: fa-sharp fa-light fa-comments
|
|
href: https://forum.letta.com
|
|
- link: DeepLearning.AI Course
|
|
icon: fa-sharp fa-light fa-building-columns
|
|
href: https://www.deeplearning.ai/short-courses/llms-as-operating-systems-agent-memory/?utm_campaign=memgpt-launch&utm_content=331638345&utm_medium=social&utm_source=docs&hss_channel=tw-992153930095251456
|
|
- link: Model Leaderboard
|
|
icon: fa-sharp fa-light fa-trophy
|
|
href: https://leaderboard.letta.com
|
|
- section: Get Started
|
|
contents:
|
|
- page: Letta Overview
|
|
path: pages/getting-started/letta_platform.mdx
|
|
- page: Quickstart
|
|
path: pages/getting-started/quickstart.mdx
|
|
- page: Core Concepts
|
|
path: pages/getting-started/core-concepts.mdx
|
|
- page: Prompts for Vibecoding
|
|
path: pages/getting-started/prompts.mdx
|
|
#- section: Supported Frameworks
|
|
# contents:
|
|
# - page: TypeScript (Node.js)
|
|
# path: pages/getting-started/ade.mdx
|
|
# - page: Python
|
|
# path: pages/getting-started/ade.mdx
|
|
# - page: Vercel AI SDK
|
|
# path: pages/frameworks/vercel.mdx
|
|
# - page: React
|
|
# path: pages/frameworks/react.mdx
|
|
# - page: Next.js
|
|
# path: pages/frameworks/next.mdx
|
|
# - page: Flask
|
|
# path: pages/frameworks/flask.mdx
|
|
# - page: Mastra
|
|
# path: pages/frameworks/mastra.mdx
|
|
|
|
- section: Agents
|
|
contents:
|
|
- page: Overview
|
|
path: pages/agents/overview.mdx
|
|
- page: Context Hierarchy
|
|
path: pages/agents/context_hierarchy.mdx
|
|
- page: Message Types
|
|
path: pages/agents/message_types.mdx
|
|
|
|
- section: Memory
|
|
path: pages/agents/memory.mdx
|
|
contents:
|
|
- page: Memory Blocks
|
|
path: pages/agents/memory_blocks.mdx
|
|
- section: Archival Memory
|
|
path: pages/agents/archival_memory_overview.mdx
|
|
contents:
|
|
- page: Searching & Querying
|
|
path: pages/agents/archival_search.mdx
|
|
- page: Best Practices
|
|
path: pages/agents/archival_best_practices.mdx
|
|
- page: Exporting Archival Memories
|
|
path: pages/agents/archival_export.mdx
|
|
- page: Agentic Context Engineering
|
|
path: pages/agents/context_engineering.mdx
|
|
|
|
- section: Agent Capabilities
|
|
contents:
|
|
- page: Streaming Responses
|
|
path: pages/agents/streaming.mdx
|
|
- page: Long-Running Executions
|
|
path: pages/agents/long_running.mdx
|
|
- page: JSON Mode & Structured Output
|
|
path: pages/agents/json_mode.mdx
|
|
- page: Multi-Modal
|
|
path: pages/agents/multimodal.mdx
|
|
- page: Filesystem
|
|
path: pages/agents/filesystem.mdx
|
|
|
|
- section: Tool Use
|
|
contents:
|
|
- page: Overview
|
|
path: pages/agents/tools.mdx
|
|
- page: Base Tools
|
|
path: pages/agents/base_tools.mdx
|
|
- section: Utilities
|
|
path: pages/agents/prebuilt_tools.mdx
|
|
contents:
|
|
- page: Web Search
|
|
path: pages/agents/web_search.mdx
|
|
- page: Code Interpreter
|
|
path: pages/agents/run_code.mdx
|
|
- page: Fetch Webpage
|
|
path: pages/agents/fetch_webpage.mdx
|
|
- page: Custom Tools
|
|
path: pages/agents/custom_tools.mdx
|
|
- page: Parallel Tool Calling
|
|
path: pages/agents/parallel_tool_calling.mdx
|
|
- page: Tool Rules
|
|
path: pages/agents/tool_rules.mdx
|
|
- page: Tool Variables
|
|
path: pages/agents/tool_variables.mdx
|
|
- page: Human-in-the-Loop
|
|
path: pages/agents/human_in_the_loop.mdx
|
|
- section: Model Context Protocol
|
|
path: pages/mcp/overview.mdx
|
|
contents:
|
|
- page: Connecting Letta to MCP
|
|
path: pages/mcp/setup.mdx
|
|
- page: Remote (SSE/HTTP) Servers
|
|
path: pages/mcp/sse.mdx
|
|
- page: Local (stdio) Servers
|
|
path: pages/mcp/stdio.mdx
|
|
|
|
- section: Configuration
|
|
contents:
|
|
- page: Multi-User (Identities)
|
|
path: pages/agents/multiuser.mdx
|
|
- page: Agent File (.af)
|
|
path: pages/agents/agentfile.mdx
|
|
- page: Scheduling
|
|
path: pages/agents/scheduling.mdx
|
|
|
|
- section: Multi-Agent
|
|
path: pages/agents/multiagent.mdx
|
|
contents:
|
|
- page: Custom Multi-Agent Tools
|
|
path: pages/agents/multiagent_custom.mdx
|
|
- page: Multi-Agent Shared Memory
|
|
path: pages/agents/multiagent_memory.mdx
|
|
|
|
- section: Experimental
|
|
contents:
|
|
- page: Groups
|
|
path: pages/agents/groups.mdx
|
|
- page: Sleep-time Agents
|
|
path: pages/agents/sleep_time_agents.mdx
|
|
- section: Voice Agents
|
|
path: pages/voice/voice.mdx
|
|
contents:
|
|
- page: Connecting to LiveKit Agents
|
|
path: pages/voice/voice_livekit.mdx
|
|
- page: Connecting to Vapi
|
|
path: pages/voice/voice_vapi.mdx
|
|
|
|
- section: Integrations
|
|
contents:
|
|
- page: Telegram Bot
|
|
path: pages/tutorials/telegram_bot.mdx
|
|
|
|
- section: Research Background
|
|
contents:
|
|
- page: Letta and MemGPT
|
|
path: pages/concepts/letta.mdx
|
|
- page: MemGPT Paper Deep Dive
|
|
path: pages/concepts/memgpt.mdx
|
|
|
|
- section: Legacy & Migration
|
|
contents:
|
|
- page: Legacy Architecture Overview
|
|
path: pages/legacy/architectures_overview.mdx
|
|
- page: Migration Guide
|
|
path: pages/legacy/migration_guide.mdx
|
|
- page: MemGPT Agents (Legacy)
|
|
path: pages/legacy/memgpt_agents_legacy.mdx
|
|
- page: Workflows (Legacy)
|
|
path: pages/legacy/workflows_legacy.mdx
|
|
- page: Low-latency Agents (Legacy)
|
|
path: pages/legacy/low_latency_agents_legacy.mdx
|
|
- page: ReAct Agents (Legacy)
|
|
path: pages/legacy/react_agents_legacy.mdx
|
|
- page: Heartbeats (Legacy)
|
|
path: pages/legacy/heartbeats_legacy.mdx
|
|
- page: Architecture Naming History
|
|
path: pages/legacy/naming_history.mdx
|
|
|
|
#- section: Tool Execution
|
|
# contents:
|
|
# - page: Overview
|
|
# path: pages/tool_execution/overview.mdx
|
|
# - section: Model Context Protocol
|
|
# contents:
|
|
# - page: What is MCP?
|
|
# path: pages/mcp/overview.mdx
|
|
# - section: Connecting Letta to MCP
|
|
# path: pages/mcp/setup.mdx
|
|
# contents:
|
|
# - page: Remote (SSE/HTTP) Servers
|
|
# path: pages/mcp/sse.mdx
|
|
# - page: Local (stdio) Servers
|
|
# path: pages/mcp/stdio.mdx
|
|
#- section: Deploying a Letta Server
|
|
# contents:
|
|
# - page: Letta Docker Image
|
|
# path: pages/server/docker.mdx
|
|
# - section: Connecting Model Providers
|
|
# contents:
|
|
# - page: OpenAI
|
|
# path: pages/models/openai.mdx
|
|
# - page: OpenAI proxy
|
|
# path: pages/models/openai_proxy.mdx
|
|
# - page: Anthropic
|
|
# path: pages/models/anthropic.mdx
|
|
# - page: DeepSeek
|
|
# path: pages/models/deepseek.mdx
|
|
# - page: AWS Bedrock
|
|
# path: pages/models/aws_bedrock.mdx
|
|
# - page: Groq
|
|
# path: pages/models/groq.mdx
|
|
# - page: xAI (Grok)
|
|
# path: pages/models/xai.mdx
|
|
# - page: Together
|
|
# path: pages/models/together.mdx
|
|
# - page: Google AI / Gemini
|
|
# path: pages/models/google.mdx
|
|
# - page: Google Vertex
|
|
# path: pages/models/google_vertex.mdx
|
|
# - page: Azure OpenAI
|
|
# path: pages/models/azure.mdx
|
|
# - page: Ollama
|
|
# path: pages/models/ollama.mdx
|
|
# - page: LM Studio
|
|
# path: pages/models/lmstudio.mdx
|
|
# - page: vLLM
|
|
# path: pages/models/vllm.mdx
|
|
# - section: Remote Hosting
|
|
# path: pages/deployment/remote.mdx
|
|
# contents:
|
|
# - page: Deploy on Railway
|
|
# path: pages/deployment/railway.mdx
|
|
# - section: Alternate Install Methods
|
|
# contents:
|
|
# - page: Using pip
|
|
# path: pages/server/pip.mdx
|
|
# - page: Installing from Source
|
|
# path: pages/server/source.mdx
|
|
#- section: Agent Templates
|
|
# contents:
|
|
# - page: Introduction to Templates
|
|
# path: pages/cloud/templates.mdx
|
|
# - page: Memory Variables
|
|
# path: pages/cloud/variables.mdx
|
|
# - page: Versioning
|
|
# path: pages/cloud/versions.mdx
|
|
- section: Additional Resources
|
|
contents:
|
|
- page: Letta Desktop Troubleshooting
|
|
path: pages/desktop/troubleshooting.mdx
|
|
- page: ADE Troubleshooting
|
|
path: pages/agent-development-environment/troubleshooting.mdx
|
|
- tab: ade
|
|
layout:
|
|
- link: Chat on Discord
|
|
icon: fa-brands fa-discord
|
|
href: https://discord.gg/letta
|
|
- link: Developer Forum
|
|
icon: fa-sharp fa-light fa-comments
|
|
href: https://forum.letta.com
|
|
- link: DeepLearning.AI Course
|
|
icon: fa-sharp fa-light fa-building-columns
|
|
href: https://www.deeplearning.ai/short-courses/llms-as-operating-systems-agent-memory/?utm_campaign=memgpt-launch&utm_content=331638345&utm_medium=social&utm_source=docs&hss_channel=tw-992153930095251456
|
|
- link: Model Leaderboard
|
|
icon: fa-sharp fa-light fa-trophy
|
|
href: https://leaderboard.letta.com
|
|
- section: ADE Guide
|
|
contents:
|
|
- page: ADE Overview
|
|
path: pages/ade-guide/overview.mdx
|
|
- section: Getting Started
|
|
path: pages/ade-guide/setup.mdx
|
|
contents:
|
|
- page: Access from your browser
|
|
icon: fa-sharp fa-light fa-browser
|
|
path: pages/ade-guide/web.mdx
|
|
- page: Download Letta Desktop
|
|
icon: fa-sharp fa-light fa-download
|
|
path: pages/desktop/install.mdx
|
|
- section: ADE Components
|
|
contents:
|
|
- page: Agent Simulator
|
|
icon: fa-sharp fa-light fa-alien-8bit
|
|
path: pages/ade-guide/simulator.mdx
|
|
- page: Context Window Viewer
|
|
icon: fa-sharp fa-light fa-eye
|
|
path: pages/ade-guide/context_window_viewer.mdx
|
|
- page: Core Memory
|
|
icon: fa-sharp fa-light fa-brain
|
|
path: pages/ade-guide/core_memory.mdx
|
|
- page: Archival Memory
|
|
icon: fa-sharp fa-light fa-box-archive
|
|
path: pages/ade-guide/archival_memory.mdx
|
|
- page: Data Sources
|
|
icon: fa-sharp fa-light fa-database
|
|
path: pages/ade-guide/data_sources.mdx
|
|
- page: Tools
|
|
icon: fa-sharp fa-light fa-wrench
|
|
path: pages/ade-guide/tools.mdx
|
|
- page: Settings
|
|
icon: fa-sharp fa-light fa-gear
|
|
path: pages/ade-guide/settings.mdx
|
|
- tab: selfhosted
|
|
layout:
|
|
- link: Chat on Discord
|
|
icon: fa-brands fa-discord
|
|
href: https://discord.gg/letta
|
|
- link: Developer Forum
|
|
icon: fa-sharp fa-light fa-comments
|
|
href: https://forum.letta.com
|
|
- link: DeepLearning.AI Course
|
|
icon: fa-sharp fa-light fa-building-columns
|
|
href: https://www.deeplearning.ai/short-courses/llms-as-operating-systems-agent-memory/?utm_campaign=memgpt-launch&utm_content=331638345&utm_medium=social&utm_source=docs&hss_channel=tw-992153930095251456
|
|
- link: Model Leaderboard
|
|
icon: fa-sharp fa-light fa-trophy
|
|
href: https://leaderboard.letta.com
|
|
#- page: Install Letta Desktop
|
|
# icon: fa-sharp fa-light fa-download
|
|
# path: pages/install.mdx
|
|
- section: Self-Hosting
|
|
contents:
|
|
- page: Overview
|
|
path: pages/selfhosting/overview.mdx
|
|
- page: Tool Execution
|
|
path: pages/tool_execution/local_tool_execution.mdx
|
|
- page: Tracing & Telemetry
|
|
path: pages/deployment/telemetry.mdx
|
|
- section: Deployment
|
|
path: pages/deployment/remote.mdx
|
|
contents:
|
|
- page: Railway
|
|
path: pages/deployment/railway.mdx
|
|
#- page: Deploying with Docker
|
|
# icon: fa-brands fa-docker
|
|
# path: pages/server/docker.mdx
|
|
#- page: Install Letta via pip
|
|
# icon: fa-brands fa-python
|
|
# path: pages/server/pip.mdx
|
|
- section: Connecting Model Providers
|
|
contents:
|
|
- page: Supported Models
|
|
path: pages/selfhosting/supported-models.mdx
|
|
- page: OpenAI
|
|
path: pages/models/openai.mdx
|
|
- page: Anthropic
|
|
path: pages/models/anthropic.mdx
|
|
- page: Gemini (Google AI)
|
|
path: pages/models/google.mdx
|
|
- page: LM Studio
|
|
path: pages/models/lmstudio.mdx
|
|
- section: See More Providers
|
|
icon: fa-sharp fa-light fa-caret-down
|
|
contents:
|
|
- page: OpenAI proxy
|
|
path: pages/models/openai_proxy.mdx
|
|
- page: DeepSeek
|
|
path: pages/models/deepseek.mdx
|
|
- page: AWS Bedrock
|
|
path: pages/models/aws_bedrock.mdx
|
|
- page: Groq
|
|
path: pages/models/groq.mdx
|
|
- page: xAI (Grok)
|
|
path: pages/models/xai.mdx
|
|
- page: Together
|
|
path: pages/models/together.mdx
|
|
- page: Google Vertex
|
|
path: pages/models/google_vertex.mdx
|
|
- page: Azure OpenAI
|
|
path: pages/models/azure.mdx
|
|
- page: Ollama
|
|
path: pages/models/ollama.mdx
|
|
- page: vLLM
|
|
path: pages/models/vllm.mdx
|
|
#- section: Remote Deployments
|
|
# contents:
|
|
# - page: Overview
|
|
# path: pages/deployment/remote.mdx
|
|
# - page: Example - Deploy on Railway
|
|
# path: pages/deployment/railway.mdx
|
|
- section: Advanced
|
|
contents:
|
|
#- page: Install with pip
|
|
# path: pages/server/pip.mdx
|
|
- page: Database Configuration
|
|
path: pages/selfhosting/postgres.mdx
|
|
- page: Performance
|
|
path: pages/selfhosting/performance.mdx
|
|
- page: pgadmin
|
|
path: pages/selfhosting/pgadmin.mdx
|
|
- page: Installing from Source
|
|
path: pages/server/source.mdx
|
|
- tab: cloud
|
|
layout:
|
|
- link: Chat on Discord
|
|
icon: fa-brands fa-discord
|
|
href: https://discord.gg/letta
|
|
- link: Developer Forum
|
|
icon: fa-sharp fa-light fa-comments
|
|
href: https://forum.letta.com
|
|
- link: DeepLearning.AI Course
|
|
icon: fa-sharp fa-light fa-building-columns
|
|
href: https://www.deeplearning.ai/short-courses/llms-as-operating-systems-agent-memory/?utm_campaign=memgpt-launch&utm_content=331638345&utm_medium=social&utm_source=docs&hss_channel=tw-992153930095251456
|
|
- link: Model Leaderboard
|
|
icon: fa-sharp fa-light fa-trophy
|
|
href: https://leaderboard.letta.com
|
|
- section: Get started
|
|
contents:
|
|
- page: Overview
|
|
path: pages/cloud/overview.mdx
|
|
#- page: Quickstart
|
|
# path: pages/getting-started/quickstart_cloud.mdx
|
|
- page: Get a Letta Cloud API key
|
|
path: pages/cloud/api_key.mdx
|
|
- section: Account
|
|
contents:
|
|
- page: Plans & Pricing
|
|
path: pages/cloud/pricing.mdx
|
|
# - page: Available Models
|
|
# path: pages/cloud/models.mdx
|
|
- page: Custom API Keys
|
|
path: pages/cloud/api_keys.mdx
|
|
hidden: true
|
|
- page: Role-Based Access Control
|
|
path: pages/cloud/rbac.mdx
|
|
- section: Deploying Agents
|
|
contents:
|
|
- page: Agent Templates Overview
|
|
path: pages/cloud/templates.mdx
|
|
- page: Template Versioning
|
|
path: pages/cloud/versions.mdx
|
|
- page: Memory Variables
|
|
path: pages/cloud/variables.mdx
|
|
- page: Client-Side Access Tokens
|
|
path: pages/cloud/client-side-tokens.mdx
|
|
# - page: Deploying via the SDK
|
|
# path: pages/cloud/variables.mdx
|
|
# - page: Deploying via the ADE
|
|
# path: pages/cloud/versions.mdx
|
|
- section: Observability
|
|
contents:
|
|
- page: Overview
|
|
path: pages/cloud/observability.mdx
|
|
- page: Monitoring
|
|
path: pages/cloud/monitoring.mdx
|
|
- page: Responses & Tracing
|
|
path: pages/cloud/responses.mdx
|
|
- tab: ref
|
|
layout:
|
|
- link: Chat on Discord
|
|
icon: fa-brands fa-discord
|
|
href: https://discord.gg/letta
|
|
- link: Developer Forum
|
|
icon: fa-sharp fa-light fa-comments
|
|
href: https://forum.letta.com
|
|
- link: DeepLearning.AI Course
|
|
icon: fa-sharp fa-light fa-building-columns
|
|
href: https://www.deeplearning.ai/short-courses/llms-as-operating-systems-agent-memory/?utm_campaign=memgpt-launch&utm_content=331638345&utm_medium=social&utm_source=docs&hss_channel=tw-992153930095251456
|
|
- link: Model Leaderboard
|
|
icon: fa-sharp fa-light fa-trophy
|
|
href: https://leaderboard.letta.com
|
|
- section: API Reference
|
|
contents:
|
|
- page: API and SDK Overview
|
|
path: pages/api/about.mdx
|
|
- changelog: ./changelog
|
|
title: Changelog
|
|
slug: changelog
|
|
- api: API Reference
|
|
display-errors: true
|
|
paginated: true
|
|
flattened: true
|
|
snippets:
|
|
typescript: "@letta-ai/letta-client"
|
|
python: letta-client
|
|
layout:
|
|
- agents:
|
|
- GET /v1/agents/
|
|
- GET /v1/agents/{agent_id}
|
|
- POST /v1/agents/
|
|
- PATCH /v1/agents/{agent_id}
|
|
- DELETE /v1/agents/{agent_id}
|
|
- endpoint: GET /v1/agents/count
|
|
hidden: true
|
|
- POST /v1/agents/import
|
|
- GET /v1/agents/{agent_id}/export
|
|
- endpoint: POST /v1/agents/search
|
|
hidden: true
|
|
- section: Blocks
|
|
contents:
|
|
- GET /v1/agents/{agent_id}/core-memory/blocks
|
|
- GET /v1/agents/{agent_id}/core-memory/blocks/{block_label}
|
|
- PATCH /v1/agents/{agent_id}/core-memory/blocks/{block_label}
|
|
- PATCH /v1/agents/{agent_id}/core-memory/blocks/attach/{block_id}
|
|
- PATCH /v1/agents/{agent_id}/core-memory/blocks/detach/{block_id}
|
|
- section: Tools
|
|
contents:
|
|
- GET /v1/agents/{agent_id}/tools
|
|
- PATCH /v1/agents/{agent_id}/tools/attach/{tool_id}
|
|
- PATCH /v1/agents/{agent_id}/tools/detach/{tool_id}
|
|
- PATCH /v1/agents/{agent_id}/tools/approval/{tool_name}
|
|
- section: Messages
|
|
contents:
|
|
- GET /v1/agents/{agent_id}/messages
|
|
- POST /v1/agents/{agent_id}/messages
|
|
- POST /v1/agents/{agent_id}/messages/stream
|
|
- POST /v1/agents/{agent_id}/messages/async
|
|
- POST /v1/agents/{agent_id}/messages/cancel
|
|
- POST /v1/agents/{agent_id}/summarize
|
|
- POST /v1/agents/{agent_id}/messages/preview-raw-payload
|
|
- POST /v1/agents/messages/search
|
|
- PATCH /v1/agents/{agent_id}/messages/{message_id}
|
|
- PATCH /v1/agents/{agent_id}/reset-messages
|
|
- section: Folders
|
|
contents:
|
|
- GET /v1/agents/{agent_id}/folders
|
|
- PATCH /v1/agents/{agent_id}/folders/attach/{folder_id}
|
|
- PATCH /v1/agents/{agent_id}/folders/detach/{folder_id}
|
|
- section: Files
|
|
contents:
|
|
- GET /v1/agents/{agent_id}/files
|
|
- PATCH /v1/agents/{agent_id}/files/{file_id}/open
|
|
- PATCH /v1/agents/{agent_id}/files/{file_id}/close
|
|
- PATCH /v1/agents/{agent_id}/files/close-all
|
|
- section: Groups
|
|
contents:
|
|
- GET /v1/agents/{agent_id}/groups
|
|
- section: Context
|
|
icon: ban
|
|
contents:
|
|
- GET /v1/agents/{agent_id}/context
|
|
- section: Core Memory
|
|
icon: ban
|
|
contents:
|
|
- GET /v1/agents/{agent_id}/core-memory
|
|
- section: Memory Variables
|
|
icon: ban
|
|
contents:
|
|
- GET /v1/agents/{agent_id}/core-memory/variables
|
|
- section: Passages
|
|
icon: ban
|
|
contents:
|
|
- GET /v1/agents/{agent_id}/archival-memory
|
|
- GET /v1/agents/{agent_id}/archival-memory/search
|
|
- POST /v1/agents/{agent_id}/archival-memory
|
|
- DELETE /v1/agents/{agent_id}/archival-memory/{memory_id}
|
|
- section: Sources
|
|
icon: ban
|
|
contents:
|
|
- GET /v1/agents/{agent_id}/sources
|
|
- PATCH /v1/agents/{agent_id}/sources/attach/{source_id}
|
|
- PATCH /v1/agents/{agent_id}/sources/detach/{source_id}
|
|
- models:
|
|
- GET /v1/models/
|
|
- endpoint: GET /v1/models/embedding
|
|
slug: list-embedding-models
|
|
- endpoint: GET /v1/models/embeddings
|
|
hidden: true
|
|
- blocks:
|
|
- GET /v1/blocks/
|
|
- GET /v1/blocks/{block_id}
|
|
- POST /v1/blocks/
|
|
- PATCH /v1/blocks/{block_id}
|
|
- DELETE /v1/blocks/{block_id}
|
|
- endpoint: GET /v1/blocks/count
|
|
hidden: true
|
|
- identities:
|
|
- GET /v1/identities/
|
|
- GET /v1/identities/{identity_id}
|
|
- POST /v1/identities/
|
|
- PUT /v1/identities/
|
|
- PATCH /v1/identities/{identity_id}
|
|
- DELETE /v1/identities/{identity_id}
|
|
- endpoint: GET /v1/identities/count
|
|
hidden: true
|
|
- tools:
|
|
- endpoint: GET /v1/tools/count
|
|
hidden: true
|
|
- folders:
|
|
- GET /v1/folders/
|
|
- GET /v1/folders/{folder_id}
|
|
- POST /v1/folders/
|
|
- PATCH /v1/folders/{folder_id}
|
|
- DELETE /v1/folders/{folder_id}
|
|
- endpoint: GET /v1/folders/count
|
|
hidden: true
|
|
- jobs
|
|
- runs
|
|
- steps
|
|
- groups:
|
|
- GET /v1/groups/
|
|
- GET /v1/groups/{group_id}
|
|
- POST /v1/groups/
|
|
- PATCH /v1/groups/{group_id}
|
|
- DELETE /v1/groups/{group_id}
|
|
- endpoint: GET /v1/groups/count
|
|
hidden: true
|
|
- providers:
|
|
- GET /v1/providers/
|
|
- GET /v1/providers/{provider_id}
|
|
- POST /v1/providers/
|
|
- PATCH /v1/providers/{provider_id}
|
|
- DELETE /v1/providers/{provider_id}
|
|
- POST /v1/providers/check
|
|
- tags
|
|
- batches:
|
|
- GET /v1/messages/batches
|
|
- GET /v1/messages/batches/{batch_id}
|
|
- POST /v1/messages/batches
|
|
- PATCH /v1/messages/batches/{batch_id}/cancel
|
|
- section: Messages
|
|
contents:
|
|
- GET /v1/messages/batches/{batch_id}/messages
|
|
- voice
|
|
- health
|
|
- projects
|
|
- templates
|
|
- client side access tokens
|
|
- section: telemetry
|
|
icon: ban
|
|
contents:
|
|
- GET /v1/telemetry/{step_id}
|
|
- section: sources
|
|
icon: ban
|
|
contents:
|
|
- GET /v1/sources/
|
|
- GET /v1/sources/{source_id}
|
|
- POST /v1/sources/
|
|
- PATCH /v1/sources/{source_id}
|
|
- DELETE /v1/sources/{source_id}
|
|
- GET /v1/sources/count
|
|
- GET /v1/sources/name/{source_name}
|
|
- GET /v1/sources/metadata
|
|
- GET /v1/sources/{source_id}/agents
|
|
- GET /v1/sources/{source_id}/files/{file_id}
|
|
- POST /v1/sources/{source_id}/upload
|
|
- GET /v1/sources/{source_id}/files
|
|
- DELETE /v1/sources/{source_id}/{file_id}
|
|
- GET /v1/sources/{source_id}/passages
|
|
|
|
- tab: showcase
|
|
layout:
|
|
- link: Chat on Discord
|
|
icon: fa-brands fa-discord
|
|
href: https://discord.gg/letta
|
|
- link: Developer Forum
|
|
icon: fa-sharp fa-light fa-comments
|
|
href: https://forum.letta.com
|
|
- link: DeepLearning.AI Course
|
|
icon: fa-sharp fa-light fa-building-columns
|
|
href: https://www.deeplearning.ai/short-courses/llms-as-operating-systems-agent-memory/?utm_campaign=memgpt-launch&utm_content=331638345&utm_medium=social&utm_source=docs&hss_channel=tw-992153930095251456
|
|
- link: Model Leaderboard
|
|
icon: fa-sharp fa-light fa-trophy
|
|
href: https://leaderboard.letta.com
|
|
- section: Examples
|
|
contents:
|
|
- page: Overview
|
|
path: pages/cookbooks_simple.mdx
|
|
- page: Your First Agent
|
|
path: pages/tutorials/hello_world.mdx
|
|
- page: Attaching and Detaching Memory Blocks
|
|
path: pages/tutorials/attaching_detaching_blocks.mdx
|
|
- page: Shared Memory Blocks
|
|
path: pages/tutorials/shared-memory-blocks.mdx
|
|
- page: Talk to Your PDF
|
|
path: pages/tutorials/pdf_chat.mdx
|
|
- section: Multi-Agent
|
|
contents:
|
|
- page: Async Multi-Agent
|
|
path: pages/tutorials/multiagent_async.mdx
|
|
- section: Agent Templates
|
|
contents:
|
|
- page: Building customer-specific relationship agents
|
|
path: pages/tutorials/customer-specific-agents.mdx
|
|
- section: RAG
|
|
contents:
|
|
- page: RAG Overview
|
|
path: pages/cookbooks/rag-overview.mdx
|
|
- page: Connect a Vector DB to Letta
|
|
path: pages/cookbooks/rag-simple.mdx
|
|
- page: Agentic RAG
|
|
path: pages/cookbooks/rag-agentic.mdx
|
|
|
|
- tab: evals
|
|
layout:
|
|
- link: Chat on Discord
|
|
icon: fa-brands fa-discord
|
|
href: https://discord.gg/letta
|
|
- link: Developer Forum
|
|
icon: fa-sharp fa-light fa-comments
|
|
href: https://forum.letta.com
|
|
- link: DeepLearning.AI Course
|
|
icon: fa-sharp fa-light fa-building-columns
|
|
href: https://www.deeplearning.ai/short-courses/llms-as-operating-systems-agent-memory/?utm_campaign=memgpt-launch&utm_content=331638345&utm_medium=social&utm_source=docs&hss_channel=tw-992153930095251456
|
|
- link: Model Leaderboard
|
|
icon: fa-sharp fa-light fa-trophy
|
|
href: https://leaderboard.letta.com
|
|
- section: Get Started
|
|
contents:
|
|
- page: Overview
|
|
path: pages/evals/overview.mdx
|
|
- page: Getting Started
|
|
path: pages/evals/getting-started.mdx
|
|
- section: Core Concepts
|
|
contents:
|
|
- page: Concepts Overview
|
|
path: pages/evals/concepts/overview.mdx
|
|
- page: Suites
|
|
path: pages/evals/concepts/suites.mdx
|
|
- page: Datasets
|
|
path: pages/evals/concepts/datasets.mdx
|
|
- page: Targets
|
|
path: pages/evals/concepts/targets.mdx
|
|
- page: Graders
|
|
path: pages/evals/concepts/graders.mdx
|
|
- page: Extractors
|
|
path: pages/evals/concepts/extractors.mdx
|
|
- page: Gates
|
|
path: pages/evals/concepts/gates.mdx
|
|
- section: Configuration
|
|
contents:
|
|
- page: Suite YAML Reference
|
|
path: pages/evals/configuration/suite-yaml.mdx
|
|
- section: Graders
|
|
contents:
|
|
- page: Tool Graders
|
|
path: pages/evals/graders/tool-graders.mdx
|
|
- page: Rubric Graders
|
|
path: pages/evals/graders/rubric-graders.mdx
|
|
- page: Multi-Metric Grading
|
|
path: pages/evals/graders/multi-metric.mdx
|
|
- section: Extractors
|
|
contents:
|
|
- page: Built-in Extractors
|
|
path: pages/evals/extractors/builtin.mdx
|
|
- page: Custom Extractors
|
|
path: pages/evals/extractors/custom.mdx
|
|
- section: Advanced
|
|
contents:
|
|
- page: Custom Graders
|
|
path: pages/evals/advanced/custom-graders.mdx
|
|
- page: Multi-Turn Conversations
|
|
path: pages/evals/advanced/multi-turn-conversations.mdx
|
|
- section: CLI Reference
|
|
contents:
|
|
- page: Commands
|
|
path: pages/evals/cli/commands.mdx
|
|
- section: Results & Metrics
|
|
contents:
|
|
- page: Understanding Results
|
|
path: pages/evals/results/overview.mdx
|
|
- section: Troubleshooting
|
|
contents:
|
|
- page: Common Issues
|
|
path: pages/evals/troubleshooting.mdx
|
|
|
|
# - tab: cookbooks
|
|
# layout:
|
|
# - section: Cookbooks
|
|
# path: pages/cookbooks.mdx
|
|
# contents:
|
|
# - section: Multi-Agent
|
|
# contents:
|
|
# - page: Async Multi-Agent
|
|
# path: pages/tutorials/multiagent_async.mdx
|
|
# - tab: community
|
|
# layout:
|
|
# - page: Developer Community
|
|
# path: pages/community.mdx
|
|
|
|
colors:
|
|
accent-primary:
|
|
light: '#0707ac'
|
|
dark: '#FF5533'
|
|
background:
|
|
light: '#ffffffff'
|
|
dark: '#0d0d0d'
|
|
card-background:
|
|
light: '#f6f6f6ff'
|
|
dark: '#151515'
|
|
header-background:
|
|
light: '#fbfbfbff'
|
|
dark: '#000000ff'
|
|
border:
|
|
light: '#eef0f2ff'
|
|
dark: '#202020'
|
|
|
|
css:
|
|
- assets/styles.css
|
|
- assets/leaderboard.css
|
|
|
|
js:
|
|
- path: assets/leaderboard.js
|
|
strategy: lazyOnload
|
|
# strategy: afterInteractive
|
|
|
|
analytics:
|
|
posthog:
|
|
api-key: ${POSTHOG_KEY}
|
|
endpoint: https://us.i.posthog.com
|
|
|
|
favicon: assets/favicon.png
|
|
|
|
logo:
|
|
href: /
|
|
light: assets/logo-light.svg
|
|
dark: assets/logo-dark.svg
|
|
|
|
navbar-links:
|
|
- type: github
|
|
value: https://github.com/letta-ai/letta
|
|
- type: filled
|
|
text: Launch ADE
|
|
href: https://app.letta.com
|
|
rounded: false
|
|
|
|
layout:
|
|
page-width: 1504px
|
|
tabs-placement: header
|
|
searchbar-placement: header
|
|
|
|
typography:
|
|
bodyFont:
|
|
name: ManropeRegularBody
|
|
paths:
|
|
- path: assets/fonts/manrope/Manrope-Regular.ttf
|
|
weight: 400
|
|
style: normal
|
|
- path: assets/fonts/manrope/Manrope-Medium.ttf
|
|
weight: 500 900
|
|
style: normal
|
|
headingsFont:
|
|
name: RoobertMediumHeading
|
|
path: assets/fonts/roobert/RoobertMedium.woff2
|
|
codeFont:
|
|
name: FiraCode
|
|
paths:
|
|
- path: assets/fonts/fira-code/FiraCode-Regular.ttf
|
|
weight: 400
|
|
style: normal
|
|
- path: assets/fonts/fira-code/FiraCode-Medium.ttf
|
|
weight: 500 900
|
|
style: normal
|
|
|
|
redirects:
|
|
- source: "/install"
|
|
destination: "/guides/ade/desktop"
|
|
- source: "/desktop"
|
|
destination: "/guides/ade/desktop"
|
|
- source: "/quickstart/desktop"
|
|
destination: "/guides/ade/desktop"
|
|
- source: "/quickstart/docker"
|
|
destination: "/guides/selfhosting"
|
|
- source: "/guides/server/pip"
|
|
destination: "/guides/selfhosting"
|
|
- source: "/quickstart/cloud"
|
|
destination: "/cloud/quickstart"
|
|
- source: "/guides/server/docker"
|
|
destination: "/guides/selfhosting"
|
|
- source: "/agent-development-environment"
|
|
destination: "/guides/ade/overview"
|
|
- source: "/guides/ade/usage"
|
|
destination: "/guides/ade/overview"
|
|
- source: "/guides/agents/mcp"
|
|
destination: "/guides/mcp/overview"
|
|
- source: "/guides/mcp/sse"
|
|
destination: "/guides/mcp/remote"
|
|
- source: "/guides/mcp/stdio"
|
|
destination: "/guides/mcp/local"
|
|
- source: "/guides/server/quickstart"
|
|
destination: "/quickstart"
|
|
- source: "/agent-development-environment/troubleshooting"
|
|
destination: "/guides/ade/troubleshooting"
|
|
- source: "/models/openai"
|
|
destination: "/guides/server/providers/openai"
|
|
- source: "/models/openai_proxy"
|
|
destination: "/guides/server/providers/openai-proxy"
|
|
- source: "/models/anthropic"
|
|
destination: "/guides/server/providers/anthropic"
|
|
- source: "/models/aws_bedrock"
|
|
destination: "/guides/server/providers/aws_bedrock"
|
|
- source: "/models/groq"
|
|
destination: "/guides/server/providers/groq"
|
|
- source: "/models/together"
|
|
destination: "/guides/server/providers/together"
|
|
- source: "/models/google"
|
|
destination: "/guides/server/providers/google"
|
|
- source: "/models/google_vertex"
|
|
destination: "/guides/server/providers/google_vertex"
|
|
- source: "/models/deepseek"
|
|
destination: "/guides/server/providers/deepseek"
|
|
- source: "/models/ollama"
|
|
destination: "/guides/server/providers/ollama"
|
|
- source: "/models/vllm"
|
|
destination: "/guides/server/providers/vllm"
|
|
- source: "/models/azure"
|
|
destination: "/guides/server/providers/azure"
|
|
- source: "/server/docker"
|
|
destination: "/guides/server/docker"
|
|
- source: "/server/pip"
|
|
destination: "/guides/server/pip"
|
|
- source: "/agents/tools"
|
|
destination: "/guides/agents/tools"
|
|
- source: "/concepts"
|
|
destination: "/concepts/letta"
|
|
- source: "/introduction"
|
|
destination: "/letta-platform"
|
|
- source: "/advanced/memory_management"
|
|
destination: "/guides/agents/memory"
|
|
- source: "/changelog"
|
|
destination: "/api-reference/changelog"
|
|
- source: "/api-changelog"
|
|
destination: "/api-reference/changelog"
|
|
- source: "/quickstart/cloud"
|
|
destination: "/quickstart"
|
|
- source: "/guides/cloud"
|
|
destination: "/guides/cloud/overview"
|
|
- source: "/guides/ade"
|
|
destination: "/guides/ade/overview"
|
|
- source: "/cloud/quickstart"
|
|
destination: "/guides/cloud/quickstart"
|
|
- source: "/letta-platform"
|
|
destination: "/overview"
|
|
- source: "/guides/agents/sleep-time-agents"
|
|
destination: "/guides/agents/architectures/sleeptime"
|
|
- source: "/guides/agents/sources"
|
|
destination: "/guides/agents/filesystem"
|
|
- source: "/guides/desktop/install"
|
|
destination: "/guides/ade/desktop"
|
|
- source: "/api-reference/agents/cancel-agent-run"
|
|
destination: "/api-reference/agents/messages/cancel"
|
|
- source: "/api-reference/messages/cancel-batch-run"
|
|
destination: "/api-reference/batches/cancel"
|
|
- source: "/guides/agents/architectures"
|
|
destination: "/guides/legacy/architectures_overview"
|
|
- source: "/guides/agents/architectures/memgpt"
|
|
destination: "/guides/legacy/memgpt_agents_legacy"
|
|
- source: "/guides/agents/heartbeats"
|
|
destination: "/guides/legacy/heartbeats_legacy"
|
|
- source: "/guides/agents/architectures/react"
|
|
destination: "/guides/legacy/react_agents_legacy"
|
|
- source: "/guides/agents/architectures/workflows"
|
|
destination: "/guides/legacy/workflows_legacy"
|
|
- source: "/guides/agents/architectures/low-latency"
|
|
destination: "/guides/legacy/low_latency_agents_legacy"
|
|
- source: "/leaderboard"
|
|
destination: "https://leaderboard.letta.com"
|
|
- source: "/leaderboard/overview"
|
|
destination: "https://leaderboard.letta.com"
|
|
- source: "/leaderboard/contributing"
|
|
destination: "https://leaderboard.letta.com"
|