> For the complete documentation index, see [llms.txt](https://docs.concurrence.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.concurrence.com/developer-guide/platform-api/platform-sdk.md).

# Platform SDK

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

The Concurrence Platform SDK (`@amigo-ai/platform-sdk`) provides a typed TypeScript client for the Platform API. The SDK defaults to `https://platform.api-us.concurrence.com` for US production in 0.113.1 and later; set `baseUrl` and `identityBaseUrl` to the hosts assigned to your deployment for any other region. It covers customer-facing resources including agents, services, conversations, calls, analytics, and simulations.

{% hint style="info" %}
**Platform API only.** Configure the Platform resource base and identity token helpers separately using [SDK Configuration](/developer-guide/platform-api/platform-sdk/configuration.md). For the Classic API (`api.amigo.ai`), see the [Classic API SDKs](/developer-guide/classic-api/sdks.md).
{% endhint %}

## Available SDK

| Property            | Value                                                                                                                                  |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| **Package**         | `@amigo-ai/platform-sdk`                                                                                                               |
| **Repository**      | [github.com/concurrence-hq/concurrence-platform-typescript-sdk](https://github.com/concurrence-hq/concurrence-platform-typescript-sdk) |
| **Registry**        | [npm](https://www.npmjs.com/package/@amigo-ai/platform-sdk)                                                                            |
| **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                                                                   |
| 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`   | Stored data-source records; nothing polls them                                              |
| 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                                                        |

`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](https://github.com/concurrence-hq/concurrence-platform-typescript-sdk/blob/main/api.md).

`client.sessions.getFleetStatus()` takes no arguments and reports voice capacity only. For the changes in each package version, see the [October package releases](https://docs.concurrence.com/api-reference/change-logs/sdk-ecosystem#october-2026-package-releases) and the [September compatibility changes](https://docs.concurrence.com/api-reference/change-logs/sdk-ecosystem#september-2026-compatibility-releases).

The generated types include `context_binding_aliases`, `skill_input_bindings`, and the memory-dimension operation. The memory-dimension operation has no resource method; call it with `client.POST()` and follow [Service-Scoped Memory](/developer-guide/platform-api/data-world-model/service-memory.md). See [Conversation Context](/developer-guide/guides/conversation-context.md) and [Skills](/developer-guide/platform-api/workspaces/skills.md) for the binding fields.

## Getting Started

1. [**Installation**](/developer-guide/platform-api/platform-sdk/installation.md)**.** Add the SDK to your project.
2. [**Configuration**](/developer-guide/platform-api/platform-sdk/configuration.md)**.** Set up authentication.
3. [**Quickstart**](/developer-guide/platform-api/platform-sdk/quickstart.md)**.** Make your first API call.
4. [**Error Handling**](/developer-guide/platform-api/platform-sdk/error-handling.md)**.** Handle errors gracefully.

## Quick Example

```typescript
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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.concurrence.com/developer-guide/platform-api/platform-sdk.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.