API Overview

v1Stable

The Apollo API is how your product talks to your agents. It has two surfaces that share one base URL and one authentication flow:

Messaging

Run conversations: send messages (with SSE or WebSocket streaming), read transcripts, rerun interactions, inspect reasoning traces, and reach users on WhatsApp or SMS.

Management

Operate your workspace: projects, agents, versions and their configuration, conversation threads, and usage metrics.

Base URL

https://api-v3.aui.io/apollo-api

Messaging endpoints live under /messaging/v1, management endpoints under /management/v1. The WebSocket session shares the same host: wss://api-v3.aui.io/apollo-api/messaging/v1/session.

Authentication in one minute

Exchange your publishable key for a short-lived access token, then send it as a Bearer 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_..." }'

The token identifies your agent — messaging calls never carry an agent_id in the body. Management endpoints also accept an organization API key as an alternative. See Authentication for the full flow.

A conversation in three calls

Get a 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_..." }'

Send the first message

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 want to dispute a charge", "user_id": "my-user-123" }'

The response includes a thread_id — a new thread was created for you. Pass it back to continue the same conversation:

Continue the conversation

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": "It was from May 30th", "user_id": "my-user-123", "thread_id": "<thread_id>" }'

Core concepts

Threads

A thread is one conversation with an agent. Threads are created automatically on the first message — no separate create call.

Interactions

Each user message and its agent reply form an interaction. Interactions can be rerun with edited text, and every one produces a reasoning trace.

Traces

The agent’s reasoning, step by step: what it understood, which rules fired, and the decisions it took.

Agents, versions & projects

Agents live in projects. An agent’s behavior is defined by its versions; exactly one version is live at a time.

Explore

Authentication

Publishable keys, access tokens, and organization API keys.

Send messages

REST, server-sent events, and reruns.

API Reference

Every endpoint, schema, and error — generated from the live API.

Errors

One error envelope with stable, machine-readable codes.