Welcome

Get started with the Amigo AI platform APIs: Classic for text-based digital health, Platform for enterprise voice and healthcare.

Official developer documentation for the Amigo AI platform.

New to Amigo? For a full understanding of Amigo's architecture and design philosophy, see the Conceptual Documentation. This developer guide focuses on API implementation and SDK usage.

Quick Start

Amigo exposes two distinct APIs for different deployment models. Pick your path.

Classic API (text-based digital health)

A single-actor system for consumer-facing chat agents, async voice notes, and WebSocket streaming.

Obtain API credentials from your Amigo representative.
Install an SDK: Python or TypeScript.
Configure authentication using the Authentication Guide.
Set your regional endpoint per Regions & Endpoints.
Run the Hello World example from the tutorial.

import { AmigoClient } from '@amigo-ai/sdk';

const client = new AmigoClient({
  apiKey: process.env.AMIGO_API_KEY!,
  apiKeyId: process.env.AMIGO_API_KEY_ID!,
  userId: process.env.AMIGO_USER_ID!,
  orgId: process.env.AMIGO_ORGANIZATION_ID!
});

const createEvents = await client.conversations.createConversation({
  body: { service_id: 'your-service-id', service_version_set_name: 'release' },
  query: { response_format: 'text' },
});

let conversationId;
for await (const event of createEvents) {
  if (event.type === 'conversation-created') conversationId = event.conversation_id;
}

const interactionEvents = await client.conversations.interactWithConversation({
  conversationId,
  input: 'Hello, Amigo!',
  query: { request_format: 'text', response_format: 'text' },
});

for await (const event of interactionEvents) {
  // handle NDJSON events; break on 'interaction-complete'
}

createConversation and interactWithConversation return NDJSON event streams (async generators) that you iterate with for await, not single response objects.

Platform API (enterprise voice and healthcare)

Multi-system enterprise deployments with phone-based voice agents, EHR integration, operator escalation, and safety monitoring.

Obtain a workspace API key from your Amigo representative.
Set your base URL to https://api.platform.amigo.ai/v1.
Authenticate with your API key as a Bearer token. See Platform API Authentication.

# List agents in your workspace
curl -s https://api.platform.amigo.ai/v1/{workspace_id}/agents \
  -H "Authorization: Bearer $AMIGO_API_KEY"

See the Platform API docs for voice agent setup, EHR integration, and operator workflows.

Some deployments span both. A health system might use the Platform API for inbound phone scheduling and the Classic API for a patient-facing chat experience.