Skip to content

Agent Controller API

Welcome to the Agent Controller API documentation. This guide provides comprehensive information for integrating with our agent controller service through REST APIs and WebSocket connections.

Overview

The Agent Controller API enables third-party applications to:

  • Create and manage tasks
  • Send messages to the agent controller
  • Receive real-time responses via WebSocket streaming
  • Retrieve task history and messages

Key Features

  • REST API: Standard HTTP endpoints for task management and message submission
  • WebSocket Streaming: Real-time message streaming with live response updates
  • Authentication: Secure API key-based authentication
  • Multi-deployment: Support for both GCP and Azure deployments

Quick Start

  1. Authentication: Obtain your network API key from your administrator
  2. Create a Task: Use the /api/v1/external/tasks endpoint to create a new conversation
  3. Send Messages: Submit messages via REST or WebSocket
  4. Handle Responses: Process streaming responses with product recommendations

Deployment Options

https://data-services.aui.io/api/ia-controller

https://azure.aui.io/api/ia-controller

What's Next?