Quickstart

Understand AUI’s products and start building in minutes.

AUI Products

AUI provides a family of products for building and integrating AI agents:

API

Integrate AI agents into your product and manage them programmatically. Send messages via REST or WebSocket, receive structured responses and streaming outputs, and operate projects, agents, and versions — ready for web, mobile, or backend use.

SDK

The official TypeScript/JavaScript client (@aui.io/aui-client) — type-safe methods, automatic retries, and built-in WebSocket handling.

CLI

Develop agents locally with a CLI-first workflow. Edit JSON configs with schema support, validate instantly, and deploy to the cloud with a single command.

Agent Builder API

Programmatically create and manage agents. Define knowledge, tools, behavior, and guardrails through a simple API — fully customizable and scalable.

	API	SDK	CLI	Agent Builder API
Purpose	Message & manage agents	Type-safe client for apps	Develop & deploy agents	Create & configure agents
Interface	REST + WebSocket	TypeScript / JavaScript	Terminal	REST
Status	v1 — Stable	Stable	Beta — GA Q2 2026	Upcoming — Q2 2026
Best for	App integration & operations	Web & Node apps	Day-to-day development	Automation & CI/CD

---

Start from the Playground

The fastest way to experience AUI is through the Playground — no code required.

1. Open the Playground

   Go to playground-v3.aui.io and log in with your AUI account.

2. Select an agent

   Choose an existing agent or create a new one to start a conversation.

3. Chat

   Send messages and see the agent respond in real time. Test how it handles different intents, activates tools, and follows rules.

4. Go to code

   When you’re ready to integrate, exchange your publishable key for an access token and send the same messages programmatically:

   cURL

   # 1. Exchange your publishable key for an access token
   curl -X POST "https://api-v3.aui.io/apollo-api/management/v1/auth/token" \
     -H "Content-Type: application/json" \
     -d '{ "grant_type": "publishable_key", "publishable_key": "pk_..." }'
   
   # 2. Send a message — a conversation thread is created automatically
   curl -X POST "https://api-v3.aui.io/apollo-api/messaging/v1/messages" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <access_token>" \
     -d '{
       "text": "I need help finding a product",
       "user_id": "my-user-123"
     }'
   

   See the API overview for the full tour.

---

Next Steps

API

Start integrating agents into your app.

CLI Installation

Install the CLI and start building agents locally.