# AUI

## Docs

- [Archive a version](https://docs.aui.io/api-reference/agent-versions/archive-a-version.md): Archive a version to retire it from everyday use. The agent's live version can't be archived — publish another version first.
- [Create a draft version](https://docs.aui.io/api-reference/agent-versions/create-a-draft-version.md): Create a new draft version — empty, from a template, or cloned from an existing version (``source`` selects which). Drafts stay editable until published.
- [List versions](https://docs.aui.io/api-reference/agent-versions/list-versions.md): List an agent's versions, newest first. Filter by status, tag, label, or version number; set ``exclude_revisions`` to see only base versions.
- [Publish a version](https://docs.aui.io/api-reference/agent-versions/publish-a-version.md): Make this version the agent's live version. Publishing a draft freezes it first; publishing an already-published version re-activates it — the same call handles shipping, switching, and rolling back.
- [Pull a configuration bundle](https://docs.aui.io/api-reference/agent-versions/pull-a-configuration-bundle.md): Download a version's configuration bundle — the current revision, or a specific one via ``version_tag``.
- [Push a configuration bundle](https://docs.aui.io/api-reference/agent-versions/push-a-configuration-bundle.md): Upload a configuration bundle to a version, committing a new revision. The response carries the new revision's tag and content digest.
- [Update a version](https://docs.aui.io/api-reference/agent-versions/update-a-version.md): Update a version's metadata: label, tags, and notes. The configuration itself changes through push, never here.
- [Create agent](https://docs.aui.io/api-reference/agents/create-agent.md): Create an agent in the project. New agents start without a live version — create and publish a version to make the agent answer.
- [Delete an agent](https://docs.aui.io/api-reference/agents/delete-an-agent.md): Delete an agent and all of its versions. This cannot be undone.
- [Get agent usage](https://docs.aui.io/api-reference/agents/get-agent-usage.md): Usage metrics for one agent, optionally bounded by a date range.
- [Get an agent](https://docs.aui.io/api-reference/agents/get-an-agent.md): Fetch one agent, including which version is currently live.
- [List agents](https://docs.aui.io/api-reference/agents/list-agents.md): List the project's agents, optionally filtered by name.
- [Update an agent](https://docs.aui.io/api-reference/agents/update-an-agent.md): Rename an agent. re-publishes the published version with the updated name. To change which version is live, publish a version instead.
- [Get an access token](https://docs.aui.io/api-reference/auth/get-an-access-token.md): Exchange a credential for a short-lived access token (OAuth 2.0, RFC 6749). Supported grant types: `publishable_key`. Refresh and other grants will be added on the same endpoint.
- [Start a channel thread](https://docs.aui.io/api-reference/channels/start-a-channel-thread.md): Send the opening message on ``channel`` and bind the recipient's phone number to a conversation thread. The agent is identified by your access token. Omit ``thread_id`` to start a new thread (its id is returned); pass it to continue an existing one. Template fields apply to WhatsApp only.
- [Health check](https://docs.aui.io/api-reference/health/health-check.md): Liveness probe. Returns ``{"status": "ok"}`` when the service is up.
- [Get follow-up suggestions](https://docs.aui.io/api-reference/messaging/get-follow-up-suggestions.md): Generate suggested follow-up prompts from a context you provide — useful for offering the end user quick next questions.
- [Get the welcome message](https://docs.aui.io/api-reference/messaging/get-the-welcome-message.md): The welcome message of the agent's live version — what to show before the first user message.
- [Get trace by interaction](https://docs.aui.io/api-reference/messaging/get-trace-by-interaction.md): The reasoning trace of a single interaction, resolved by its id.
- [Get trace by thread](https://docs.aui.io/api-reference/messaging/get-trace-by-thread.md): Every interaction trace in the thread.
- [List thread messages](https://docs.aui.io/api-reference/messaging/list-thread-messages.md): The thread's full transcript, in chronological order.
- [Rerun an interaction](https://docs.aui.io/api-reference/messaging/rerun-an-interaction.md): Regenerate ``interaction_id`` on the thread against the agent's live version, then replay ``text`` onto the resulting new thread. The response's ``thread_id`` is the new thread's id, not the original.
- [Send a message](https://docs.aui.io/api-reference/messaging/send-a-message.md): Send a message; auto-create the thread when ``thread_id`` is omitted. For a live token stream use ``POST /messages/stream`` (SSE). The resolved thread id is returned in the body.
- [Stream a message](https://docs.aui.io/api-reference/messaging/stream-a-message.md): Send a message and stream the reply token-by-token over Server-Sent Events. The thread is created automatically when ``thread_id`` is omitted — the resolved id arrives as the first ``thread`` event. Resume a dropped stream with the standard ``Last-Event-ID`` header: missed events replay without runn…
- [Create project](https://docs.aui.io/api-reference/projects/create-project.md): Create a project in your organization. Projects group agents.
- [Delete a project](https://docs.aui.io/api-reference/projects/delete-a-project.md): Delete a project. It disappears from listings immediately.
- [Get a project](https://docs.aui.io/api-reference/projects/get-a-project.md): Fetch one project.
- [Get project usage](https://docs.aui.io/api-reference/projects/get-project-usage.md): Usage metrics aggregated across every agent in the project, optionally bounded by a date range.
- [List projects](https://docs.aui.io/api-reference/projects/list-projects.md): List your organization's projects.
- [Get a thread](https://docs.aui.io/api-reference/threads/get-a-thread.md): Fetch one thread's details — title, participants, and status.
- [Get an interaction's trace](https://docs.aui.io/api-reference/threads/get-an-interactions-trace.md): The reasoning trace of a single interaction, resolved by its id.
- [List thread messages](https://docs.aui.io/api-reference/threads/list-thread-messages.md): The thread's full transcript, in chronological order.
- [List thread traces](https://docs.aui.io/api-reference/threads/list-thread-traces.md): The reasoning trace of every interaction in the thread — what the agent understood, which rules fired, and the decisions it took.
- [List threads](https://docs.aui.io/api-reference/threads/list-threads.md): List your organization's conversation threads, newest first. Repeatable filters (``tool``, ``rule``, ``param``, ``created``) OR within a field and AND across fields.
- [Update a thread](https://docs.aui.io/api-reference/threads/update-a-thread.md): Partial update — only ``title`` is updatable for now. Omitted fields are left unchanged; the full updated thread is returned.
- [Authentication](https://docs.aui.io/api/authentication.md): Exchange a publishable key for an access token, then send it as a Bearer token.
- [Errors](https://docs.aui.io/api/errors.md): One error envelope with stable, machine-readable codes.
- [Agents](https://docs.aui.io/api/management/agents.md): Create and manage agents inside your projects.
- [Projects](https://docs.aui.io/api/management/projects.md): Projects group your agents within an organization.
- [Threads](https://docs.aui.io/api/management/threads.md): List, filter, inspect, and rename conversation threads across your organization.
- [Usage](https://docs.aui.io/api/management/usage.md): Interaction and token metrics per agent or across a project.
- [Versions](https://docs.aui.io/api/management/versions.md): An agent's behavior, versioned: draft, publish, roll back.
- [Channels (WhatsApp & SMS)](https://docs.aui.io/api/messaging/channels.md): Reach users on WhatsApp or SMS — your agent handles the conversation.
- [Send Messages](https://docs.aui.io/api/messaging/send-messages.md): Send messages to your agent — complete responses, token streaming, and reruns.
- [Threads](https://docs.aui.io/api/messaging/threads.md): Conversations are threads — created automatically, readable any time.
- [Traces](https://docs.aui.io/api/messaging/traces.md): Inspect the agent's reasoning: what it understood, which rules fired, what it decided.
- [WebSocket](https://docs.aui.io/api/messaging/websocket.md): A bidirectional session for live chat UIs — streaming replies with gap-free recovery.
- [API Overview](https://docs.aui.io/api/overview.md): Talk to your Apollo-1 agents and manage them programmatically — one API, two surfaces.
- [Changelog](https://docs.aui.io/changelog.md): Latest updates, new features, and API changes.
- [Command Reference](https://docs.aui.io/cli/commands.md): Complete reference for every AUI Agent Builder CLI command.
- [Configuration](https://docs.aui.io/cli/configuration.md): Project structure, config files, and environment variables for the AUI Agent Builder CLI.
- [Installation](https://docs.aui.io/cli/installation.md): Install the AUI Agent Builder CLI and authenticate with your account.
- [AUI Agent Builder CLI](https://docs.aui.io/cli/overview.md): Build, manage, and deploy AI agent configurations from your terminal with a local-first workflow.
- [Workflows](https://docs.aui.io/cli/workflows.md): Common development workflows and best practices for the AUI Agent Builder CLI.
- [Apollo-1: Reasoning in Code, Not Weights](https://docs.aui.io/introduction.md): A new kind of reasoning over language — reasoning you can read, that runs exactly as written.
- [Agent Hierarchy](https://docs.aui.io/overview/agent-hierarchy.md): Understanding Apollo-1's three-level organizational structure
- [Agent Settings](https://docs.aui.io/overview/agent-settings.md): Core settings that define agent identity and behavior
- [Shared Entities & Parameters](https://docs.aui.io/overview/shared-entities.md): Your agent's ontology — the structured vocabulary available across all tools
- [Quickstart](https://docs.aui.io/quickstart.md): Understand AUI's products and start building in minutes.
- [Best Practices](https://docs.aui.io/sdk/best-practices.md): Error handling, timeouts, key hygiene, and patterns that hold up in production.
- [Management Client](https://docs.aui.io/sdk/management.md): Operate projects, agents, versions, threads, and usage — server-side, with your organization API key.
- [Messaging Client](https://docs.aui.io/sdk/messaging.md): Send messages, stream replies, read conversations, and reach users on channels — with a publishable key.
- [Migration Guide (v2 → v3)](https://docs.aui.io/sdk/migration.md): The exact before/after for every call and response when upgrading @aui.io/aui-client from v2 to v3.
- [SDK](https://docs.aui.io/sdk/overview.md): The official TypeScript/JavaScript SDK for the Apollo API — two type-safe clients, one per credential.
- [WebSocket](https://docs.aui.io/sdk/websocket.md): Real-time messaging sessions with typed envelopes, reconnection, and resume.

## OpenAPI Specs

- [openapi](https://api-v3.aui.io/apollo-api/openapi.json)

## Optional

- [Playground](https://playground-v3.aui.io)
- [Website](https://www.aui.io)
- [GitHub](https://github.com/aui-io)