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: chat agents, async voice notes, WebSocket streaming, user management, simulations, and data access. It was built for consumer-facing digital health products.

Overview

The Classic API is a RESTful API at https://api.amigo.ai/v1/{organization}/... that lets developers run conversations, manage users, deploy tools, and execute simulations. Endpoints use standard HTTP methods (GET, POST, PUT, DELETE) and return JSON responses (conversation endpoints stream NDJSON events). The API is versioned (/v1/) so that existing integrations keep working as the platform evolves.

Key capabilities:

Organization Management: create and configure organizations
Agents and 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
Dynamic Behaviors: trigger-based rules that inject instructions or change tool availability mid-conversation
Metrics: typed evaluation criteria for scoring conversation quality
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