Platform API Overview

Implement workspace data, agent configuration, conversations, integrations, and operations through the Amigo Platform API.

The Platform API connects workspace data, configured agents, supported voice and messaging workflows, integrations, and operational controls. Start with the resource that owns your task, then follow its endpoint contract and lifecycle guidance.

For the architecture behind these resources, read Core Concepts. The Getting Started guide covers the initial integration sequence.

Base URL

Use the regional hostname assigned to your deployment. https://api.platform.amigo.ai is the US default; it does not route a workspace to another region. HTTP paths in the public schema include the /v1 prefix. SDK baseUrl configuration takes the origin without that prefix.

See Regions & Endpoints for regional configuration. Confirm access to any separate test deployment with your Amigo representative.

Authentication

Workspace API keys can authenticate supported workspace resource routes as Bearer credentials. Interactive identity, external-user sessions, and machine-to-machine authorization have separate flows and scopes. Health routes can be unauthenticated. Follow Authentication & API Keys and the specific resource guide instead of applying one credential rule to every endpoint.

Workspace-Scoped Design

Workspace-scoped resources enforce the credential's access to the workspace in the path. Account, identity, and workspace-management operations have their own boundaries. Creating a workspace does not automatically provision a channel, load source data, or configure a service.

An association with a Classic organization does not make the two APIs' IDs or credentials interchangeable. Use the API and resource names in the implementation map.

Resource Guide

Use these groups to find the implementation path. The sidebar includes the detailed pages for each resource.

Authentication & Platform

Authentication and protocol guides. Their scope depends on the route.

Authentication & API Keys

• OAuth2 (Machine-to-Machine) - token endpoint, scope resolution, and token claims for the client_credentials grant
• OAuth2 Clients - client registration, scopes, setup allow-lists, and secret rotation
• Sessions - persistent WebSocket endpoint for low-latency text conversations
• Pagination - continuation-token and limit/offset pagination styles
• Health - unauthenticated endpoints for external health monitors

Workspaces & Configuration

Workspace setup and the resources that define agent behavior.

Workspaces

• Agents - agent identity, guidance, and versioning
• Skills - companion definitions and the state bindings that govern their execution
• Services - bind agents and context graphs into deployable units with version sets
• Use Cases & Bindings - channel use cases and service bindings
• Scheduling Rule Sets - deterministic appointment slot filtering rules
• Voice Configuration - per-service voice pipeline tuning
• Client Config - client-safe configuration values for browser-side apps

Conversations & Channels

Runtime conversation surfaces across phone, text, and web.

Conversations

• Channels and Channel Manager - channel provisioning and routing
• Calls and Voice Agent - voice call records and the real-time voice pipeline
• SMS - managed message sending, consent boundaries, and delivery evidence
• Voicemail - migration note for the retired standalone ringless channel
• Runs - unified run inventory and channel-neutral controls
• Desktop Sessions - the supported desktop-session contract
• Surfaces - agent-generated data collection forms
• Operators - operator escalation and takeover
• SSE Events and Observer Events - streaming event schemas
• Serve an Agent From a Web App - embed an agent in your own web application

Platform Functions & Tools

Data functions and tools the agent can call mid-conversation.

Platform Functions

• Workspace Data Queries - parameterized SQL templates over workspace tables
• Tool Testing - resolve and execute context graph tools in isolation
• Triggers - schedule recurring actions or fire them from external systems
• MCP Server - workspace-scoped Model Context Protocol surface for external clients
• Agent Runs, Harness Context, and Agent Definitions - supported framework execution and authored definitions

Integrations

Connecting agents to external systems and external users to agents.

Integrations

• Approval-Gated Integration Writes - supported conversation-scoped approval
• Review Queue - the separate private-preview connector proposal workflow
• External Integrations - scoped credentials for third-party session creation
• External Principals - entity-anchored, role-scoped tool access for external users
• External User Subject-Key Binding - bind verified external identity into integration auth

Data & World Model

The event-sourced patient data store and its ingestion paths.

Data & World Model

• Entity Resolve - entity lookup and current resolution boundaries
• Bulk Import - migration-oriented ingestion
• Workspace Tables - workspace-owned custom data tables
• Customer Data Intake and Intake Sources - dataset file ingestion and source discovery
• Intake Upload Links - migration note for the retired link and external HMAC paths
• Connector Runner - supported ingestion and policy-eligible delivery
• FHIR - FHIR clinical data endpoints
• Data Access (MCP) - standalone SQL access for external MCP clients using Classic API organization credentials

Scribe

Scribe serves provider documentation workflows through a separately configured deployment. Follow its sessions and artifacts guides for provider ownership, credentials, and completion behavior.

Safety & Monitoring

Runtime safety, quality evaluation, and observability.

Safety & Monitoring

• Analytics & Observability - call analytics and quality trends
• Insights and Metric Store - derived metrics and storage
• Call Trace Analysis and Voice Judge - per-call evaluation
• Production Evals and Simulation Coverage - evaluation pipelines
• Prompt Logs - full LLM input/output for auditing and debugging
• Trace Export - exporting traces for offline analysis

Classic API features not in Platform API. Dynamic Behaviors (rule-based triggers) and User Management are available only through the Classic API. The Platform API has its own testing and evaluation surfaces - Simulation Coverage, Production Evals, and the Metric Store - and handles user context through the World Model.

Pagination

Most resource list endpoints use continuation-token pagination (items, has_more, continuation_token, optional total); a fixed set of endpoint groups uses limit/offset instead. See Pagination for both styles, the limit/offset endpoint list, and per-endpoint limits.

API Reference

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