# Astropods | Documentation

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.astropods.com/_mcp/server

## Docs

- [Welcome to Astropods](https://docs.astropods.com/welcome.md): Deploy and run AI agents with agent-native infrastructure
- [The agent lifecycle](https://docs.astropods.com/agent-lifecycle.md): How a project becomes a running agent, and which page covers each stage
- [Install the CLI](https://docs.astropods.com/install-cli.md): Download and set up the ast CLI
- [Your first project](https://docs.astropods.com/get-started.md): Create and run your first agent locally
- [Your first blueprint](https://docs.astropods.com/blueprints.md): Build and publish your agent to the Astropods registry
- [Deploy your first agent](https://docs.astropods.com/deploy-agent.md): Run a blueprint as a live hosted agent
- [Knowledge stores](https://docs.astropods.com/knowledge-stores.md): Connect a database once and share it across your agents
- [Agent card](https://docs.astropods.com/agent-card.md): Control how your agent appears in the registry with an AGENT.md file
- [Managing secrets](https://docs.astropods.com/secrets.md): Store and reference API keys and credentials in the account vault
- [Managing your agents](https://docs.astropods.com/managing-agents.md): Inspect, control, update, and clean up deployed agents
- [Working with accounts](https://docs.astropods.com/accounts.md): Understand account scoping and switch between accounts
- [Access control](https://docs.astropods.com/access-control.md): Who can see and change each resource in your account, and why a denial looks like a missing page
- [Manage access with groups](https://docs.astropods.com/access-groups.md): Give a team of people the same access to a deployment, blueprint, or knowledge store
- [Audiences](https://docs.astropods.com/audiences.md): Keep one list of people and grant several agents access to it
- [Authentication](https://docs.astropods.com/authentication.md): Log in and manage credentials for the Astropods CLI and API
- [Usage](https://docs.astropods.com/usage.md): See what an account has spent and created this period, and request more of a capped resource
- [Usage limits](https://docs.astropods.com/usage-limits.md): Warn yourself before an account spends too much, and stop it before it spends more
- [Monitor your agents](https://docs.astropods.com/monitor-agents.md): Send OpenTelemetry traces from your agent to see token usage, tool calls, and latency in the Astropods dashboard
- [AI SDK](https://docs.astropods.com/monitor-ai-sdk.md): Send Vercel AI SDK telemetry to Astropods and optionally serve the agent over Astropods messaging
- [Mastra](https://docs.astropods.com/monitor-mastra.md): Automatically instrument Mastra agents for monitoring in Astropods
- [Claude Agent SDK](https://docs.astropods.com/monitor-claude-agent-sdk.md): Automatically instrument Claude Agent SDK for monitoring in Astropods
- [Monitor external agents](https://docs.astropods.com/monitor-external-agents.md): Bring telemetry from AI tools running outside Astropods into your dashboard
- [Claude Code](https://docs.astropods.com/monitor-claude-code.md): Stream Claude Code usage telemetry from your team into Astropods
- [RFC-1: Astropods Spec](https://docs.astropods.com/astropods-package-spec.md): Declarative YAML format for AI agent topology
- [RFC-3: Agent Card Spec](https://docs.astropods.com/agent-card-spec.md): Specification for the AGENT.md file format
- [RFC-4: Evaluator Spec](https://docs.astropods.com/evaluator-spec.md): Declarative YAML format for an agent's evaluation set
- [Known integrations](https://docs.astropods.com/known-integrations.md): Recognized integrations with brand icons
- [Support](https://docs.astropods.com/support.md): Get help with Astropods and reach the team
- [Changelog](https://docs.astropods.com/docs/changelog/changelog/llms.txt)
- [Guides](https://docs.astropods.com/guides.md): Task-shaped walkthroughs for things you build on top of a deployed agent
- [Serve a frontend from your agent](https://docs.astropods.com/frontend-agents.md): Configure an agent that ships its own web UI instead of a chat sidecar
- [Ask the user for input](https://docs.astropods.com/ask-for-input.md): Pause mid-turn, collect typed input as a form, and resume with the answer
- [Ask for input from a Mastra tool](https://docs.astropods.com/ask-for-input-mastra.md): Suspend a tool for a confirmation or a value, and resume with the answer
- [Store data with SQLite](https://docs.astropods.com/agent-sqlite.md): Give your agent a place to save data that sticks around
- [Using knowledge stores](https://docs.astropods.com/knowledge-store-agent.md): Give your agent a database it can read from and write to
- [Connect to OAuth-protected MCP servers](https://docs.astropods.com/mcp-oauth.md): Connect a deployed agent to hosted MCP servers and complete the OAuth flow at deploy time using your agent's public URL
- [Manually authorize requests](https://docs.astropods.com/manual-authz.md): Reproduce the access checks that the messaging sidecar runs for you
- [Egress IP allowlisting](https://docs.astropods.com/ip-allowlisting.md): Let agents reach a database behind your firewall over the public network
- [Govern agent access with Lumos](https://docs.astropods.com/lumos.md): Manage who can use your agents from Lumos, with your own approvals and access reviews
- [Troubleshooting stuck deployments](https://docs.astropods.com/troubleshooting-deployments.md): Why a deploy can get stuck in the deploying state, and how to recover
- [Messaging SDK](https://docs.astropods.com/messaging-sdk.md): Connect your agent to Slack, web chat, and other platforms over gRPC
- [The conversation stream](https://docs.astropods.com/messaging-sdk/conversation-stream.md): Open the bidirectional ProcessConversation stream and handle inbound events
- [Inbound message anatomy](https://docs.astropods.com/messaging-sdk/messages.md): The Message shape every platform adapter normalizes to
- [Sending a response](https://docs.astropods.com/messaging-sdk/responses.md): Stream text, status updates, prompts, attachments, and errors back to the platform
- [Receiving platform feedback](https://docs.astropods.com/messaging-sdk/feedback.md): Handle reactions, prompt clicks, edits, deletions, and stream control
- [Audio](https://docs.astropods.com/messaging-sdk/audio.md): Receive raw audio bytes, run your own STT, and send back a transcript
- [Trace context](https://docs.astropods.com/messaging-sdk/trace-context.md): Correlate a response, and the feedback that references it, back to its trace
- [Auxiliary RPCs](https://docs.astropods.com/messaging-sdk/rpcs.md): Thread history, conversation metadata, one-shot messages, and health checks
- [Reconnection](https://docs.astropods.com/messaging-sdk/reconnection.md): Survive a dropped stream with backoff and buffered writes
- [Files in chat](https://docs.astropods.com/messaging-sdk/files-in-chat.md): Read user uploads and return downloadable files from a messaging agent
- [Save a conversation from another source](https://docs.astropods.com/messaging-sdk/saved-conversations.md): Copy a Slack thread, an email chain, or any other transcript into a user's Astropods chat history
- [Worked examples](https://docs.astropods.com/messaging-sdk/examples.md): Complete Slack, web chat, and cross-platform agent loops
- [SDK reference](https://docs.astropods.com/messaging-sdk/reference.md): Every symbol each messaging SDK exports, and where the protos live
- [Adapters overview](https://docs.astropods.com/adapters/overview.md): Bridges between your agent framework and the Astropods runtime
- [Custom adapter (Node)](https://docs.astropods.com/adapters/node/custom-adapter.md): Build a custom adapter with @astropods/adapter-core
- [Authorizing requests (Node)](https://docs.astropods.com/adapters/node/auth.md): Check who is calling the HTTP surface your agent serves
- [Sandboxes](https://docs.astropods.com/adapters/node/sandboxes.md): Run agent-generated code in an isolated VM from the TypeScript SDK
- [Custom adapter (Python)](https://docs.astropods.com/adapters/python/custom-adapter.md): Build a custom adapter with astropods-adapter-core
- [Authorizing requests (Python)](https://docs.astropods.com/adapters/python/auth.md): Check who is calling the HTTP surface your agent serves
- [Mastra adapter](https://docs.astropods.com/adapters/mastra.md): Connect a Mastra Agent to the Astropods runtime
- [LangChain adapter](https://docs.astropods.com/adapters/langchain.md): Connect a LangChain / LangGraph agent to the Astropods runtime
- [AI Gateway](https://docs.astropods.com/ai-gateway.md): Use Astropods-provided LLM access without managing your own provider keys
- [Supported models](https://docs.astropods.com/ai-gateway/models.md): Model ids the AI Gateway accepts, and what each one is for
- [Chat completions](https://docs.astropods.com/ai-gateway/chat.md): Call the gateway from any OpenAI-compatible client, with streaming and structured output
- [Embeddings](https://docs.astropods.com/ai-gateway/embeddings.md): Turn text into vectors for RAG and semantic search
- [Vision](https://docs.astropods.com/ai-gateway/vision.md): Send images alongside text to a vision-capable model
- [Web search](https://docs.astropods.com/ai-gateway/web-search.md): Let a GPT model ground its answers in current search results
- [Anthropic API](https://docs.astropods.com/ai-gateway/anthropic.md): Run Claude Code and the Claude Agent SDK against the gateway's native Messages passthrough
- [Errors and limits](https://docs.astropods.com/ai-gateway/limits.md): Status codes the gateway returns, and the capabilities it doesn't offer
- [CLI overview](https://docs.astropods.com/cli.md): Create, develop, and deploy agents from your terminal with the ast CLI
- [ast project](https://docs.astropods.com/cli/project.md): Create an agent harness and run it locally
- [ast blueprint](https://docs.astropods.com/cli/blueprint.md): Build, push, deploy, and manage blueprints in the registry
- [ast agent](https://docs.astropods.com/cli/agent.md): Inspect, control, and remove deployed agents
- [ast secrets](https://docs.astropods.com/cli/secrets.md): Store and manage account secrets and plain variables
- [ast account](https://docs.astropods.com/cli/account.md): List the accounts you belong to and switch the active one
- [ast spec](https://docs.astropods.com/cli/spec.md): Validate astropods.yml against the spec schema
- [ast settings](https://docs.astropods.com/cli/settings.md): Control telemetry and install shell completions
- [Top-level commands](https://docs.astropods.com/cli/top-level.md): Session, upgrade, and documentation commands that take no subcommand
- [API reference](https://docs.astropods.com/api-reference.md): Astropods REST API for agents and accounts

## API Docs

- Astropods API > agents [List agents](https://docs.astropods.com/api-reference/astropods-api/agents/list-agents.md)
- Astropods API > agents [Get agent](https://docs.astropods.com/api-reference/astropods-api/agents/get-agent.md)
- Astropods API > agents [Register agent](https://docs.astropods.com/api-reference/astropods-api/agents/register-agent.md)
- Astropods API > agents [Publish agent version](https://docs.astropods.com/api-reference/astropods-api/agents/publish-agent.md)
- Astropods API > agents [Get agent config](https://docs.astropods.com/api-reference/astropods-api/agents/get-agent-config.md)
- Astropods API > agents [Get deployment template](https://docs.astropods.com/api-reference/astropods-api/agents/get-deployment-template.md)
- Astropods API > deployments [Get active deployment](https://docs.astropods.com/api-reference/astropods-api/deployments/get-active-deployment.md)
- Astropods API > deployments [Get deployment history](https://docs.astropods.com/api-reference/astropods-api/deployments/get-deployment-history.md)
- Astropods API > deployments [List deployments](https://docs.astropods.com/api-reference/astropods-api/deployments/list-deployments.md)
- Astropods API > deployments [Authorize a deployment request](https://docs.astropods.com/api-reference/astropods-api/deployments/authorize-deployment.md)
- Astropods API > deployments [Deploy agent](https://docs.astropods.com/api-reference/astropods-api/deployments/deploy-agent.md)
- Astropods API > deployments [Validate deployment](https://docs.astropods.com/api-reference/astropods-api/deployments/validate-deployment.md)
- Astropods API > deployments [Undeploy agent](https://docs.astropods.com/api-reference/astropods-api/deployments/undeploy-agent.md)
- Astropods API > deployments [Get pod logs](https://docs.astropods.com/api-reference/astropods-api/deployments/get-deployment-logs.md)
- Astropods API > deployments [Restart pod](https://docs.astropods.com/api-reference/astropods-api/deployments/restart-pod.md)
- Astropods API > deployments [Get ConfigMap data](https://docs.astropods.com/api-reference/astropods-api/deployments/get-config-map-data.md)
- Astropods API > deployments [Get secret keys](https://docs.astropods.com/api-reference/astropods-api/deployments/get-secret-keys.md)
- Astropods API > deployments [Trigger ingestion](https://docs.astropods.com/api-reference/astropods-api/deployments/trigger-ingestion.md)
- Astropods API > observability [Get metrics](https://docs.astropods.com/api-reference/astropods-api/observability/get-observability-metrics.md)
- Astropods API > observability [Get observability summary](https://docs.astropods.com/api-reference/astropods-api/observability/get-observability-summary.md)
- Astropods API > observability [List traces](https://docs.astropods.com/api-reference/astropods-api/observability/get-observability-traces.md)
- Astropods API > accounts [Get profile](https://docs.astropods.com/api-reference/astropods-api/accounts/get-profile.md)
- Astropods API > accounts [Create account](https://docs.astropods.com/api-reference/astropods-api/accounts/create-account.md)
- Astropods API > accounts [Check account name](https://docs.astropods.com/api-reference/astropods-api/accounts/check-account-name.md)
- Astropods API > accounts [Get account](https://docs.astropods.com/api-reference/astropods-api/accounts/get-account.md)
- Astropods API > accounts [Rename account](https://docs.astropods.com/api-reference/astropods-api/accounts/rename-account.md)
- Astropods API > accounts [Stream account agent events (SSE)](https://docs.astropods.com/api-reference/astropods-api/accounts/stream-account-events.md)
- Astropods API > chat [List chat conversations](https://docs.astropods.com/api-reference/astropods-api/chat/list-chat-conversations.md)
- Astropods API > chat [Get chat conversation](https://docs.astropods.com/api-reference/astropods-api/chat/get-chat-conversation.md)
- Astropods API > chat [Delete chat conversation](https://docs.astropods.com/api-reference/astropods-api/chat/delete-chat-conversation.md)
- Astropods API > chat [Rename chat conversation](https://docs.astropods.com/api-reference/astropods-api/chat/set-chat-conversation-title.md)
- Astropods API > chat [Create chat conversation](https://docs.astropods.com/api-reference/astropods-api/chat/create-chat-conversation.md)
- Astropods API > chat [Send a chat message](https://docs.astropods.com/api-reference/astropods-api/chat/send-chat-message.md)
- Astropods API > chat [Stop generating](https://docs.astropods.com/api-reference/astropods-api/chat/cancel-chat-generation.md)
- Astropods API > chat [Stream assistant reply (SSE)](https://docs.astropods.com/api-reference/astropods-api/chat/stream-chat-conversation.md)
- Astropods API > files [List deployment files](https://docs.astropods.com/api-reference/astropods-api/files/list-deployment-files.md)
- Astropods API > files [Reserve a deployment file](https://docs.astropods.com/api-reference/astropods-api/files/create-deployment-file.md)
- Astropods API > files [Get deployment file storage usage](https://docs.astropods.com/api-reference/astropods-api/files/get-deployment-file-storage-usage.md)
- Astropods API > files [Get deployment file metadata](https://docs.astropods.com/api-reference/astropods-api/files/get-deployment-file.md)
- Astropods API > files [Delete a deployment file](https://docs.astropods.com/api-reference/astropods-api/files/delete-deployment-file.md)
- Astropods API > files [Download deployment file content](https://docs.astropods.com/api-reference/astropods-api/files/download-deployment-file-content.md)
- Astropods API > files [Upload deployment file content](https://docs.astropods.com/api-reference/astropods-api/files/upload-deployment-file-content.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.astropods.com/openapi.json)
- [OpenAPI YAML](https://docs.astropods.com/openapi.yaml)