Classic API

Classic API reference for text-based conversations, user management, tools, simulations, and metrics.

This is the Classic API for text-based digital health experiences. It uses organization-scoped endpoints at api.amigo.ai/v1 with per-user JWT authentication. For enterprise voice deployments with phone-based agents, EHR integration, and operator workflows, see the Platform API.

The Classic API provides programmatic access to text-based conversational AI capabilities - chat agents, async voice notes, WebSocket streaming, user management, simulations, and data access. Built for consumer-facing digital health products.

Overview

The Classic API is a RESTful API at https://api.amigo.ai/v1/{organization}/... that enables developers to run conversations, manage users, deploy tools, and execute simulations. All endpoints return JSON responses and support standard HTTP methods (GET, POST, PUT, DELETE). The API is versioned (/v1/) to ensure backward compatibility.

Key capabilities:

• Organization Management - Create and configure organizations

• Agents & Context Graphs - Define agent personas and conversational flows

• User Management - Create and manage users, customize preferences

• Service Discovery - List available AI services and configurations

• Tool Management - Version and deploy custom tools for agents

• Conversations - Create, interact with, and manage AI conversations

• Real-time Streaming - WebSocket support for live voice and events

• Simulations - Evaluate and test agent behavior with automated test suites

• Admin - Platform configuration and debugging utilities

All operations are organization-scoped and require authentication. For complete endpoint specifications, see the API Reference.

API Categories

Organization Management

Organization

Agents & Context Graphs

Agents & Context Graphs

User Management

Users

Service Management

Services

Tools

Tools

Admin

Admin

Conversations

The core of the Amigo platform for managing AI-powered conversations:

Endpoint	Description
Create	Initialize new conversations
Interact	Send messages and receive responses
Events	Real-time event streaming
Lifecycle	Manage conversation states
Voice	Voice-enabled conversations
Real-time Voice (WebSocket)	Low-latency streaming via WebSocket
External Events & Multi-Stream	Interleave external events and audio
Conversation History	Retrieve messages and interactions

Simulations

Simulations - Evaluate and test agent behavior using simulated personas and scenarios:

Endpoint	Description
Personas	Simulated user profiles with background and role
Scenarios	Conversation test scripts with objectives
Unit Tests	Individual test cases combining persona + scenario
Unit Test Sets	Grouped test suites with run counts
Unit Test Set Runs	Execute suites and retrieve results

Authentication

All API requests require authentication. See the Authentication Guide for details.

Base URLs

Region	Endpoint
US	https://api.amigo.ai/v1
CA	https://api-ca-central-1.amigo.ai/v1
EU	https://api-eu-central-1.amigo.ai/v1
AU	https://api-ap-southeast-2.amigo.ai/v1

Regional Configuration See Regions & Endpoints for guidance on choosing the right regional base URL and configuring dedicated clusters.