REST API Specs
Browse the Classic, Platform, and Scribe API contracts, find the matching implementation guide, and interpret Amigo's release history.
This space contains generated REST contracts and release history. Choose the API assigned to your deployment, then inspect its operations and models. Use the Developer Guide for setup and integration workflows, and the conceptual documentation for architecture and operating boundaries.
Choose Your Next Step
Use Current Upgrade Guidance for compatibility and migration decisions, or the generated Classic and Platform reference below for exact contracts. To build a first working client, follow the Developer Guide starter. Technical buyers can start with the evaluation packet.
Choose an API
Workspace data, configured agents, voice and messaging workflows, integrations, and operations; some routes have account or identity scope
Provider-owned clinical sessions and artifacts with separate scopes and deployment base
Organization-scoped users, services, conversations, Actions, Dynamic Behaviors, and simulations
Platform and Classic credentials, identifiers, and request bodies are not interchangeable. Getting Started explains the choice and the regional endpoint to configure.
Read an Operation
The generated pages show the operation's path, method, parameters, body, responses, and schema references from the selected OpenAPI specification. The Models pages collect shared schemas; a model's presence alone does not expose a callable operation.
Use the operation's declared server and authentication requirements. A request made with the interactive API client uses real credentials against the selected endpoint. Choose the intended test workspace or organization before executing a mutation.
The schema describes the wire contract. It does not establish provisioning, regional feature availability, permission to perform every listed action, or completion of an asynchronous workflow. The corresponding Developer Guide explains those conditions and the evidence to inspect after a request.
Additional Protocols and Deployments
Provider documentation workflows
Scribe, using the supplied deployment base and provider-session credentials
Persistent text WebSocket
Platform Sessions, including connection parameters, frames, and lifecycle
Workspace MCP clients
Classic organization data exploration
Data-MCP, a standalone service with Classic organization credentials
Scribe HTTP operations have a dedicated schema-backed reference. The other protocols are not automatically covered by the generated REST page trees. Follow their individual protocol and authentication guides.
SDK Ecosystem
Check the package version snapshot and release notes before upgrading. A published SDK can lag the live API schema; use the guide's compatibility notes when a helper and server differ.
Release History
Change Logs record customer-relevant API, SDK, CLI, and web changes. Historical entries explain what changed at the time. Use the current operation reference and implementation guide to determine what is available now.
Last updated
Was this helpful?
