Platform API

Platform API reference for voice agents, EHR integration, operators, FHIR, and safety monitoring.

The Platform API (api.platform.amigo.ai) powers voice-first enterprise and traditional healthcare deployments. It provides workspace-scoped endpoints for managing agents, services, phone numbers, EHR integrations, operator escalation, FHIR clinical data, and safety monitoring.

This is not the Classic API. The Classic API at api.amigo.ai is built for text-based digital health experiences (chat agents, async voice notes, WebSocket streaming). The Platform API is built for enterprise voice deployments with phone-based agents, EHR sync, and operator workflows. See the landing page for a full comparison.

Base URL

Environment	Base URL
Production	https://api.platform.amigo.ai/v1

A staging environment is available for development and testing. Contact your Amigo representative for staging access.

Resource endpoints are scoped by workspace ID: /v1/{workspace_id}/agents, /v1/{workspace_id}/skills, etc.

Workspace management endpoints live under /v1/workspaces.

Authentication

All requests require a workspace-scoped API key as a Bearer token:

curl https://api.platform.amigo.ai/v1/{workspace_id}/agents \
  -H "Authorization: Bearer <YOUR_API_KEY>"

See Authentication & API Keys for details on key lifecycle, RBAC roles, and rotation.

Workspace-Scoped Design

Every resource belongs to a workspace, an isolated tenant with its own agents, services, skills, phone numbers, integrations, and data.

Workspace vs Organization: The Classic API scopes by organization. The Platform API scopes by workspace. A workspace maps to an organization via the backend_org_id field, bridging the two API surfaces.

Resource Guide

Configuration

WorkspacesAuthentication & API Keys

Agent Configuration

AgentsSkillsServices

Infrastructure

Integrations

Voice & Calls

Voice AgentOperators

Data Pipeline

Connector RunnerData & World ModelFHIRData Access (MCP)

Automation

Triggers

Monitoring

Safety & MonitoringAnalytics & Observability

Classic API features not in Platform API. Simulations (automated agent testing), Metrics (conversation quality evaluation), Dynamic Behaviors (rule-based triggers), and User Management are available only through the Classic API. Platform API handles testing through workspace-level workflows and user context through the World Model.

Pagination

The Platform API uses two pagination styles depending on the endpoint:

1. Continuation-token pagination - used by most resource list endpoints. Responses return items, has_more, and continuation_token, with an optional total.

2. Limit/offset pagination - used by the endpoints listed in Pagination (audit, metrics, intake, and others).

A continuation-token list response looks like:

{
  "items": [...],
  "total": 142,
  "has_more": true,
  "continuation_token": 20
}

Parameter	Default	Range	Description
limit	10	1-100	Items per page (some endpoints set a lower default, such as 20, but the model-level maximum is 100)
continuation_token	0	-	Offset for next page (returned in response)

The total field is optional and only populated for endpoints that opt in, so it is not returned on every paginated response. See Pagination for the full list of limit/offset endpoints and their limits.

API Reference

For full endpoint schemas, see the auto-generated Platform API Reference.