> For the complete documentation index, see [llms.txt](https://docs.amigo.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.amigo.ai/developer-guide/platform-api/platform-api.md). # 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](/developer-guide/readme.md) 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 %%{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 " ``` See [Authentication & API Keys](/developer-guide/platform-api/platform-api/authentication.md) 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="/pages/u4TQxi28BJWhEKUfNGTC" %} [Workspaces](/developer-guide/platform-api/platform-api/workspaces.md) {% endcontent-ref %} {% content-ref url="/pages/pgUT371DPqo400yNGm8c" %} [Authentication & API Keys](/developer-guide/platform-api/platform-api/authentication.md) {% endcontent-ref %} ### Agent Configuration {% content-ref url="/pages/anWN9601T2X4MSFL1OLz" %} [Agents](/developer-guide/platform-api/platform-api/agents.md) {% endcontent-ref %} {% content-ref url="/pages/SsmKm0VLk3kjGLW48Z2o" %} [Skills](/developer-guide/platform-api/platform-api/skills.md) {% endcontent-ref %} {% content-ref url="/pages/Uzf9BYWr2iCpbLM4QkRS" %} [Services](/developer-guide/platform-api/platform-api/services.md) {% endcontent-ref %} ### Infrastructure {% content-ref url="/pages/8XgxpLXbTwEa0DfgJstX" %} [Integrations](/developer-guide/platform-api/platform-api/integrations.md) {% endcontent-ref %} {% content-ref url="/pages/01Ybzk3bfjSHcKLuQP4C" %} [Serve an Agent From a Web App](/developer-guide/platform-api/platform-api/serve-agent-from-web-app.md) {% endcontent-ref %} ### Voice & Calls {% content-ref url="/pages/UNKq4O9ZYECUs1wDX4UZ" %} [Voice Agent](/developer-guide/platform-api/platform-api/voice-agent.md) {% endcontent-ref %} {% content-ref url="/pages/dL0hNPKme6SzOGCAZFn5" %} [Operators](/developer-guide/platform-api/platform-api/operators.md) {% endcontent-ref %} ### Data Pipeline {% content-ref url="/pages/v42Fsg57vEBUpu3ylqLl" %} [Connector Runner](/developer-guide/platform-api/platform-api/connector-runner.md) {% endcontent-ref %} {% content-ref url="/pages/UZmj9knjuYak24tQk90Y" %} [Data & World Model](/developer-guide/platform-api/platform-api/data-world-model.md) {% endcontent-ref %} {% content-ref url="/pages/LXRLDnvwudhH6iAQ5Yh5" %} [FHIR](/developer-guide/platform-api/platform-api/fhir.md) {% endcontent-ref %} {% content-ref url="/pages/5XJYNqgEQ7ARIdTNdOVB" %} [Data Access (MCP)](/developer-guide/platform-api/platform-api/data-mcp.md) {% endcontent-ref %} ### Automation {% content-ref url="/pages/ulYn1NySWyoUBW1fiFgJ" %} [Triggers](/developer-guide/platform-api/platform-api/triggers.md) {% endcontent-ref %} ### Monitoring {% content-ref url="/pages/eN4MWcO2S0Wu6cGRs2Fo" %} [Safety & Monitoring](/developer-guide/platform-api/platform-api/safety.md) {% endcontent-ref %} {% content-ref url="/pages/wwsPZTD9eURZzhula8Fg" %} [Analytics & Observability](/developer-guide/platform-api/platform-api/analytics.md) {% 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](/developer-guide/classic-api/core-api.md). Platform API handles testing through workspace-level workflows and user context through the [World Model](/developer-guide/platform-api/platform-api/data-world-model.md). {% endhint %} ## 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](/developer-guide/platform-api/platform-api/pagination.md) (audit, metrics, intake, and others). A continuation-token list response looks like: ```json { "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](/developer-guide/platform-api/platform-api/pagination.md) for the full list of limit/offset endpoints and their limits. ## API Reference For full endpoint schemas, see the auto-generated [Platform API Reference](https://docs.amigo.ai/api-reference/readme/platform). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.amigo.ai/developer-guide/platform-api/platform-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.