# Classic API

{% hint style="info" %}
**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](https://docs.amigo.ai/developer-guide/platform-api/platform-api).
{% endhint %}

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](https://docs.amigo.ai/api-reference).

## API Categories

### Organization Management

{% content-ref url="core-api/organization" %}
[organization](https://docs.amigo.ai/developer-guide/classic-api/core-api/organization)
{% endcontent-ref %}

### Agents & Context Graphs

{% content-ref url="core-api/agents-and-context-graphs" %}
[agents-and-context-graphs](https://docs.amigo.ai/developer-guide/classic-api/core-api/agents-and-context-graphs)
{% endcontent-ref %}

### User Management

{% content-ref url="core-api/users" %}
[users](https://docs.amigo.ai/developer-guide/classic-api/core-api/users)
{% endcontent-ref %}

### Service Management

{% content-ref url="core-api/services" %}
[services](https://docs.amigo.ai/developer-guide/classic-api/core-api/services)
{% endcontent-ref %}

### Tools

{% content-ref url="core-api/tools" %}
[tools](https://docs.amigo.ai/developer-guide/classic-api/core-api/tools)
{% endcontent-ref %}

### Admin

{% content-ref url="core-api/admin" %}
[admin](https://docs.amigo.ai/developer-guide/classic-api/core-api/admin)
{% endcontent-ref %}

### Conversations

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

| Endpoint                                                                                                                                              | Description                          |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| [**Create**](https://docs.amigo.ai/developer-guide/classic-api/core-api/conversations/conversations-create)                                           | Initialize new conversations         |
| [**Interact**](https://docs.amigo.ai/developer-guide/classic-api/core-api/conversations/conversations-interact)                                       | Send messages and receive responses  |
| [**Events**](https://docs.amigo.ai/developer-guide/classic-api/core-api/conversations/conversations-events)                                           | Real-time event streaming            |
| [**Lifecycle**](https://docs.amigo.ai/developer-guide/classic-api/core-api/conversations/conversations-lifecycle)                                     | Manage conversation states           |
| [**Voice**](https://docs.amigo.ai/developer-guide/classic-api/core-api/conversations/conversations-voice)                                             | Voice-enabled conversations          |
| [**Real-time Voice (WebSocket)**](https://docs.amigo.ai/developer-guide/classic-api/core-api/conversations/conversations-realtime)                    | Low-latency streaming via WebSocket  |
| [**External Events & Multi-Stream**](https://docs.amigo.ai/developer-guide/classic-api/core-api/conversations/conversations-realtime-external-events) | Interleave external events and audio |
| [**Conversation History**](https://docs.amigo.ai/developer-guide/classic-api/core-api/conversations/conversation-history)                             | Retrieve messages and interactions   |

### Simulations

[**Simulations**](https://docs.amigo.ai/developer-guide/classic-api/core-api/simulations) - Evaluate and test agent behavior using simulated personas and scenarios:

| Endpoint                                                                                                                       | Description                                        |
| ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
| [**Personas**](https://docs.amigo.ai/developer-guide/classic-api/core-api/simulations/simulation-personas)                     | Simulated user profiles with background and role   |
| [**Scenarios**](https://docs.amigo.ai/developer-guide/classic-api/core-api/simulations/simulation-scenarios)                   | Conversation test scripts with objectives          |
| [**Unit Tests**](https://docs.amigo.ai/developer-guide/classic-api/core-api/simulations/simulation-unit-tests)                 | Individual test cases combining persona + scenario |
| [**Unit Test Sets**](https://docs.amigo.ai/developer-guide/classic-api/core-api/simulations/simulation-unit-test-sets)         | Grouped test suites with run counts                |
| [**Unit Test Set Runs**](https://docs.amigo.ai/developer-guide/classic-api/core-api/simulations/simulation-unit-test-set-runs) | Execute suites and retrieve results                |

## Authentication

All API requests require authentication. See the [Authentication Guide](https://docs.amigo.ai/developer-guide/getting-started/authentication) 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` |

{% hint style="info" %}
**Regional Configuration**\
See [Regions & Endpoints](https://docs.amigo.ai/developer-guide/getting-started/regions-and-endpoints) for guidance on choosing the right regional base URL and configuring dedicated clusters.
{% endhint %}