> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.astropods.com/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.astropods.com/_mcp/server. # API Reference ## 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 [Switch chat branch](https://docs.astropods.com/api-reference/astropods-api/chat/switch-chat-branch.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) > **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.astropods.com/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.astropods.com/_mcp/server. # API reference The Astropods API lets you list and inspect agents, register and push builds, and retrieve deployment configuration. It is used by the `ast` CLI and the Astropods dashboard. ## Base URL Requests go to your Astropods server, for example: ``` https://api.astro.example.com/api/v1 ``` The base URL is set when you run `ast login` and is stored in your profile. ## Authentication * **Public:** `GET /agents` (list public catalog) and `GET /agents/:account/:name` (public view of an agent) do not require authentication. * **Authenticated:** All other endpoints require a Bearer token. Use `ast login` to obtain and store tokens; the CLI sends them automatically. Send the token in the header: ``` Authorization: Bearer ``` ## Agents | Method | Endpoint | Description | | ------ | --------------------------------- | ------------------------------------------------------------------------------------------- | | GET | `/agents` | List all agents with at least one published version (public) | | GET | `/agents/:account/:name` | Get agent details and versions (public sees published only; account members see all builds) | | POST | `/agents/:account/:name/register` | Register or update an agent build (auth, account owner/admin) | | POST | `/agents/:account/:name/publish` | Push a build with a semver version (auth, account owner/admin) | | GET | `/agents/:account/:name/config` | Get required credentials for deploying the latest build (auth) | ## Profile | Method | Endpoint | Description | | ------ | -------- | -------------------------------------------- | | GET | `/me` | Get current user profile and accounts (auth) |