Welcome

Choose the correct Amigo API, configure credentials and region, and follow implementation guides for data, agents, channels, and operations.

Build an integration with Amigo using the API and credentials assigned to your deployment. This guide connects setup, SDK examples, and endpoint contracts to the workflow you want to implement.

For the system model and deployment responsibilities, start with Core Concepts and Operating Model. For generated operation and schema references, use the API Reference.

Choose a Task

Goal	Start here
Evaluate architecture and deployment fit	Technical evaluation packet
Build a first Platform integration	First Verified Conversation
Choose Platform, Classic, or Scribe access	Choose Credentials
Verify an action or managed channel	Task guides
Investigate an incomplete result	Troubleshooting
Plan an upgrade	Current integration and upgrade guidance

Quick Start

Choose your API before installing a client or copying a request. Both APIs support conversational workflows; the distinction is their resource and authentication contracts, not simply text versus voice.

Platform API

Use the workspace-scoped Platform API for deployed agent workflows, shared world-model data, supported voice and messaging channels, integrations, and operator controls.

1. Confirm the workspace ID and regional endpoint.
2. Configure the credential accepted by your route.
3. Install the Platform TypeScript SDK, or use the HTTP examples in the resource guides.
4. Run the SDK quickstart to inspect your workspace before creating or changing resources.
5. Follow Build and Prove, then Operate and Improve.

Classic API

Use the organization-scoped Classic API for integrations built around Classic users, services, conversation event streams, Actions, and Dynamic Behaviors.

1. Confirm the organization ID, user ID, and regional endpoint.
2. Set up the Classic API key-to-token exchange.
3. Install a Classic SDK: amigo-sdk for Python or @amigo-ai/sdk for TypeScript.
4. Run Hello World, including incremental handling of conversation events.
5. Continue with the Classic resource guide.

API Comparison

Decision	Platform API	Classic API
Resource boundary	Workspace for workspace-scoped resources; some identity and management routes have other scopes	Organization and authenticated user
Credential flow	Workspace keys, interactive identity credentials, or scoped OAuth credentials on their supported routes	API key credentials exchanged for a user bearer token
Conversation paths	Text turns, persistent sessions, phone calls, and managed messaging with channel-specific lifecycles	Conversation create/interact streams, voice notes, and supported realtime paths
Agent capabilities	Context Graph tool bindings, Skills, platform functions, and integrations	Versioned Tools/Actions and Dynamic Behaviors
Client packages	@amigo-ai/platform-sdk	@amigo-ai/sdk, amigo-sdk

Shared names such as service, agent, or version set do not make IDs, credentials, payloads, or SDK methods interchangeable. Core Concepts maps each resource to its owning API.

System Architecture

For a workflow that crosses data retrieval, agent execution, an external action, and human follow-up, read How It Works. This guide owns the implementation details for those boundaries.

Documentation Structure

Guides follow the customer workflow: Build, Prove, Operate, Improve, Data, and Govern. Scribe has its own provider workflow. Use Compatibility and Retirements for Classic setup and removed interfaces.

Your next task	Start here
Establish credentials and regional routing	Getting Started
Configure agents, services, and version selection	Platform resources or Classic resources
Build a specific workflow	Guides
Use a typed client	Platform SDK or Classic SDKs
Connect workspace data and external systems	Data & World Model and Integrations
Query Classic organization data	Data Access
Inspect runtime outcomes	Runs, Operators, and Safety & Monitoring
Maintain an existing deployment	Best Practices, with each page's API and CLI scope
Check terminology or compatibility	Reference and Change Logs

Support and Resources

Use the public schema embedded in each endpoint section for its request and response contract. The surrounding prose explains authorization, lifecycle, failure handling, and availability that a schema alone cannot establish. WebSocket and separately served routes identify their own protocol or schema boundary.

For deployment-specific access and support, contact your Amigo representative through your agreed support channel. Report SDK issues in the relevant package repository: Platform TypeScript, Classic TypeScript, or Classic Python.