REST API Specs
API references and changelogs for Classic, Platform, and Scribe APIs, plus SDKs and developer tooling.
Amigo exposes two general-purpose REST API surfaces, each auto-generated from its OpenAPI spec. A deployment-scoped Scribe API serves provider documentation workflows, and a separate active Data-MCP service provides organization-scoped data exploration over the Model Context Protocol:
Provider-owned clinical documentation
Provider session bearer token
/v1/openapi.json on the supplied Scribe API base
Read-only SQL exploration of Classic organization data
Classic bearer token + X-Org-Id, or Classic API key/ID/user headers + X-Org-Id
N/A (MCP protocol)
Classic API covers conversations, users, tools, simulations, and data access. Organization-scoped with per-user JWT auth. Built for consumer-facing digital health products.
Platform API covers workspaces, agents, skills, services, integrations, phone numbers, operators, EHR sync, FHIR, CRM, quality evaluation, and compliance controls. Requests use workspace API keys or scoped bearer tokens. Built for enterprise voice deployments and healthcare operations. Endpoint-specific filters, pagination, errors, and rate-limit behavior are defined in the Platform OpenAPI schema.
Scribe API covers provider-owned clinical documentation sessions and their transcripts, notes, summaries, checklists, and coding suggestions. It uses provider session tokens and a deployment-specific base URL.
Data-MCP is an active, standalone service for compatible MCP clients using Classic API organization credentials. Its seven tools query, describe, sample, and profile the tables visible to that credential (sql_query, describe_query, tables, table_schema, sample_data, table_detail, profile_column). Platform workspace clients instead use the Platform API MCP server, while in-conversation agent data access uses platform functions.
See the Developer Guide for integration guidance across these API surfaces.
SDK Ecosystem
The Classic and Platform APIs are available through official SDKs. Current package versions live in the Current SDK Packages table so they are maintained in one place.
SDK Features
The Classic SDKs provide:
Automatic authentication: API key exchange for bearer tokens with proactive refresh
Retry with backoff: exponential backoff with jitter, Retry-After header support
NDJSON streaming: async generators for conversation create and interact endpoints
Type safety: full type definitions generated from the OpenAPI spec
Error hierarchy: typed error classes mapped to HTTP status codes
Multi-Provider LLM Support
Amigo supports multiple model providers, but model selection is configured by the resource and channel rather than through one universal per-interaction field. Use the Classic service and version-set contracts or the Platform agent, skill, service, version-set, and voice configuration documented for your workflow. The OpenAPI schema identifies any endpoint-specific request overrides.
Ecosystem Tools
Developer Guide: endpoint reference, SDK guides, and integration patterns
Platform TypeScript SDK: generated client, API reference, and integration guides
Classic TypeScript examples: runnable examples for the Classic TypeScript SDK
Classic Python examples: runnable examples for the Classic Python SDK
SDK Ecosystem Changelog: release history for TypeScript and Python SDKs, developer tooling, and documentation
Last updated
Was this helpful?
