# Platform API

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.

{% hint style="warning" %}
**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](https://docs.amigo.ai/developer-guide/readme) for a full comparison.
{% endhint %}

## Base URL

| Environment    | Base URL                           |
| -------------- | ---------------------------------- |
| **Production** | `https://api.platform.amigo.ai/v1` |

{% hint style="info" %}
A staging environment is available for development and testing. Contact your Amigo representative for staging access.
{% endhint %}

{% @mermaid/diagram content="%%{init: {"theme": "base", "themeVariables": {"primaryColor": "#D4E2E7", "primaryTextColor": "#100F0F", "primaryBorderColor": "#083241", "lineColor": "#575452", "textColor": "#100F0F", "clusterBkg": "#F1EAE7", "clusterBorder": "#D7D2D0"}}}%%
flowchart TB
subgraph Voice\["Enterprise Voice & Healthcare"]
PA\["Platform API\napi.platform.amigo.ai"]
end
subgraph Text\["Digital Health"]
CA\["Classic API\napi.amigo.ai"]
end
PA -.->|shared agent\nidentity & config| CA" %}

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:

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

See [Authentication & API Keys](https://docs.amigo.ai/developer-guide/platform-api/platform-api/authentication) 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.

{% hint style="info" %}
**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.
{% endhint %}

## Resource Guide

### Configuration

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

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

### Agent Configuration

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

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

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

### Infrastructure

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

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

### Voice & Calls

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

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

### Data Pipeline

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

{% content-ref url="platform-api/data-world-model" %}
[data-world-model](https://docs.amigo.ai/developer-guide/platform-api/platform-api/data-world-model)
{% endcontent-ref %}

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

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

### Monitoring

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

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

{% hint style="info" %}
**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](https://docs.amigo.ai/developer-guide/classic-api/core-api). Platform API handles testing through workspace-level workflows and user context through the [World Model](https://docs.amigo.ai/developer-guide/platform-api/platform-api/data-world-model).
{% endhint %}

## Pagination

List endpoints return paginated results:

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

| Parameter            | Default | Range | Description                                 |
| -------------------- | ------- | ----- | ------------------------------------------- |
| `limit`              | 10      | 1–20  | Items per page                              |
| `continuation_token` | 0       | -     | Offset for next page (returned in response) |

The `total` field returns the total count of matching records across all pages, not just the current page. This is available on all paginated list responses.

## API Reference

For full endpoint schemas, see the auto-generated [Platform API Reference](https://docs.amigo.ai/api-reference/readme/platform).