Skip to main content
v1Stable
The Messaging API lets you programmatically send messages to AUI agents, manage conversation tasks, and receive responses — either synchronously via REST or streamed in real time via WebSocket.

​
Base URL

https://data-services.aui.io/api/ia-controller
Two regional deployments are available:
RegionBase URL
GCPhttps://data-services.aui.io/api/ia-controller
Azurehttps://azure.aui.io/api/ia-controller

​
Authentication

All requests require the x-network-api-key header: 
x-network-api-key: your-network-api-key

​
Core concepts

Tasks

A task represents a conversation session with an agent. Create a task to start a new conversation, then send messages within it.

Messages

Send a message to an agent within a task and receive the complete response, including product recommendations and follow-up suggestions.

WebSocket

Connect via WebSocket for real-time streaming responses. Text is streamed token-by-token as the agent generates it.

Errors

Consistent error format across all endpoints with status codes, descriptions, and dynamic contextual data.

​
How it works

  1. Create a task — POST /api/v1/external/tasks with a user_id to start a conversation session. You receive a task ID and a welcome message.
  2. Send messages — Use either the REST endpoint (POST /api/v1/external/message) for complete responses or connect via WebSocket (wss://.../api/v1/external/session) for real-time streaming.
  3. Handle responses — Responses include the agent’s text, product recommendations (if applicable), and AI-generated follow-up suggestions.

​
Quick start

cURL
# 1. Create a task
curl -X POST "https://data-services.aui.io/api/ia-controller/api/v1/external/tasks" \
  -H "Content-Type: application/json" \
  -H "x-network-api-key: your-api-key" \
  -d '{"user_id": "user_123"}'

# 2. Send a message (use the task_id from step 1)
curl -X POST "https://data-services.aui.io/api/ia-controller/api/v1/external/message" \
  -H "Content-Type: application/json" \
  -H "x-network-api-key: your-api-key" \
  -d '{
    "task_id": "68e78d0dc5a4b19a030d03d6",
    "text": "I am looking for a built-in microwave with at least 20 liters capacity"
  }'

​
Explore the API

Tasks

Create tasks, list user tasks, and retrieve message history.

Messages

Send messages and receive agent responses.

WebSocket

Real-time streaming responses via WebSocket connection.

Errors

Error codes and response format.