Platform SDK

Use the official TypeScript SDK for typed workspace resources, unified runs, streaming conversations, retries, errors, analytics, and configuration.

The Amigo Platform SDK (@amigo-ai/platform-sdk) provides a typed TypeScript client for the Platform API. It defaults to the US endpoint at api.platform.amigo.ai; set baseUrl to the hostname assigned to a workspace in another region. It covers customer-facing resources including agents, services, conversations, calls, analytics, and simulations.

Platform API only. This SDK targets Platform API deployments, using the US endpoint by default and a baseUrl override for other assigned regions. For the Classic API (api.amigo.ai), see the Classic API SDKs.

Available SDK

Property	Value
Package	@amigo-ai/platform-sdk
Repository	github.com/amigo-ai/amigo-platform-typescript-sdk
Registry	npm
Node.js Version	20+
Language	TypeScript (ships ESM + CJS, full .d.ts types)

Key Features

• Typed client surface. Supported operations expose generated request and response types. Branded ID types (AgentId, ServiceId, and so on) help prevent cross-resource ID mixups at compile time.
• Workspace-aware resources. Resource methods inject the configured workspace ID when the API route requires it; account-level and authentication helpers use their corresponding unscoped routes.
• Streaming support. Server-sent event streaming for conversation turns, plus WebSocket URL helpers for real-time text sessions.
• Built-in request error handling. Typed request errors with HTTP status codes when a response is available; streaming and webhook helpers expose their own structured errors.
• Zero-config retries. Automatic exponential backoff for eligible transient reads and POST 429 responses that include Retry-After.
• Dual module output. ESM and CJS, validated on Node.js 20, 22, and 24.

Covered Resources

Resource	Client Property	Description
Workspaces	client.workspaces	Workspace info and settings
API Keys	client.apiKeys	Create and manage API keys
Agents	client.agents	Agents and agent versions
Agent Runs	client.agentRuns	Read-only harness context; hosted framework-run creation is retired
Runs	client.runs	Unified conversation and framework run listing, detail, trajectories, and operator controls
Actions	client.actions	Reusable AI capabilities agents can call
Services	client.services	Published deployable services
Context Graphs	client.contextGraphs	Conversation flow graphs
Data Sources	client.dataSources	External data connectors
World	client.world	Entities, events, relationships, timelines
Calls	client.calls	Call records, outbound call creation, and intelligence
Conversations	client.conversations	Text conversations, turns, and streaming
Sessions	client.sessions	Live session monitoring and fleet status
Integrations	client.integrations	External system integration configs
Analytics	client.analytics	Call volume, quality, trends
Simulations	client.simulations	Voice simulation sessions
Settings	client.settings	Voice, branding, outreach, retention

The current SDK no longer exposes client.billing, client.useCases, or client.agentDefinitions. Remove calls to these retired resources when upgrading; earlier changelog entries describe their historical availability.

client.skills is a deprecated alias for client.actions; the underlying REST path stays /skills for backward compatibility. The full client surface, including additional resources such as metrics, recordings, audit, compliance, and surfaces, is listed in the repository's api.md.

Version 0.108.1 is published on npm and retains the 0.108.0 removal of the unsupported options argument from client.sessions.getFleetStatus(). Call it without arguments for voice capacity; do not use that result as tool-runner capacity. See the release and upgrade guidance.

Getting Started

1. Installation. Add the SDK to your project.
2. Configuration. Set up authentication.
3. Quickstart. Make your first API call.
4. Error Handling. Handle errors gracefully.

Quick Example

import { AmigoClient } from '@amigo-ai/platform-sdk'

const client = new AmigoClient({
  apiKey: process.env.AMIGO_API_KEY!,
  workspaceId: process.env.AMIGO_WORKSPACE_ID!,
})

const { items: agents } = await client.agents.list()
console.log(`You have ${agents.length} agents`)

License

MIT License.