> 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/readme.md).

# Developer Guide

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

Build an integration with Concurrence 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.

Start with [regions and endpoints](/developer-guide/getting-started/regions-and-endpoints.md) and [credentials](/developer-guide/getting-started/credentials.md) when connecting a deployment. You can run the local starter before access is provisioned.

## Choose a Task

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href="/developer-guide/guides/first-verified-conversation.md"><strong>Run your first conversation</strong></a></td><td>Start with a credential-free fixture, then connect a provisioned test service and inspect the saved answer.</td></tr><tr><td><a href="/developer-guide/guides/data-to-verified-action.md"><strong>Connect data and actions</strong></a></td><td>Follow a source record through retrieval, authorization, and confirmation in the target system.</td></tr><tr><td><a href="/developer-guide/guides/build-and-prove.md"><strong>Test and release a workflow</strong></a></td><td>Configure the service, evaluate representative cases, and prepare promotion and recovery.</td></tr><tr><td><a href="/developer-guide/guides/operate-and-improve.md"><strong>Operate and troubleshoot</strong></a></td><td>Locate a run, inspect its evidence, reconcile the result, and select the next action.</td></tr></tbody></table>

Already have Console access? Use [First Console Conversation](/developer-guide/guides/first-console-conversation.md). For provider documentation workflows, start with [Scribe: Capture to Finalized Note](/developer-guide/guides/scribe-capture-to-note.md). The [guide index](/developer-guide/guides.md) groups channel, governance, and integration tasks by outcome.

## 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.

Use [Choose Credentials](/developer-guide/getting-started/credentials.md) for Platform, Classic, and Scribe access. Keep the hosts, package names, and imports shown in the examples, including `amigo` identifiers; see [Rebrand and Compatibility](https://docs.concurrence.com/reference/concurrence-rebrand).

{% tabs %}
{% tab title="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. Download and run [First Verified Conversation](/developer-guide/guides/first-verified-conversation.md) locally. The starter includes the SDK and needs no Concurrence credentials in local mode.
2. When your test workspace is ready, confirm its ID, [regional endpoint](/developer-guide/getting-started/regions-and-endpoints.md), and [accepted credential](/developer-guide/platform-api/platform-api/authentication.md).
3. [Create a Test Service](/developer-guide/guides/create-a-test-service.md) if you need an agent, graph, and service. Complete the starter's **Provisioned test service** checklist, then run it against that service and inspect the result.
4. Follow [Build and Prove](/developer-guide/guides/build-and-prove.md), then [Operate and Improve](/developer-guide/guides/operate-and-improve.md). Use the [SDK quickstart](/developer-guide/platform-api/platform-sdk/quickstart.md) to explore additional operations.
   {% endtab %}

{% tab title="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](/developer-guide/getting-started/regions-and-endpoints.md).
2. Set up the [Classic API key-to-token exchange](/developer-guide/getting-started/authentication.md).
3. Install a [Classic SDK](/developer-guide/classic-api/sdks/sdk-installation.md): `amigo-sdk` for Python or `@amigo-ai/sdk` for TypeScript.
4. Run [Hello World](/developer-guide/classic-api/sdks/sdk-hello-world.md), including incremental handling of conversation events.
5. Continue with the [Classic resource guide](/developer-guide/classic-api/core-api.md).
   {% endtab %}
   {% endtabs %}

## 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, integrations, and dynamic behavior sets that adjust guidance | 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](/developer-guide/getting-started/core-concepts.md) 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](https://docs.concurrence.com/platform-overview/how-it-works). This guide owns the implementation details for those boundaries.

## Documentation Structure

Use the [implementation path](/developer-guide/guides.md#implementation-path) to move from access to a verified result, release, and operation. For architecture decisions, start with [Architecture and Deployment](https://docs.concurrence.com/platform-overview/architecture-and-deployment).

### Browse Reference Areas by Task <a href="#browse-reference-areas-by-task" id="browse-reference-areas-by-task"></a>

[Guides](/developer-guide/guides.md) follow the customer workflow: Build, Evaluate, Operate, Improve, Data, and Govern. [Scribe](/developer-guide/guides/scribe-capture-to-note.md) has its own provider workflow. Use [Compatibility and Retirements](/developer-guide/guides/compatibility-and-retirements.md) for Classic setup and release history.

| Your next task                                    | Start here                                                                                                                                                                                             |
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Establish credentials and regional routing        | [Getting Started](/developer-guide/getting-started.md)                                                                                                                                                 |
| Configure agents, services, and version selection | [Platform resources](/developer-guide/platform-api/platform-api.md) or [Classic resources](/developer-guide/classic-api/core-api.md)                                                                   |
| Build a specific workflow                         | [Guides](/developer-guide/guides.md)                                                                                                                                                                   |
| Use a typed client                                | [Platform SDK](/developer-guide/platform-api/platform-sdk.md) or [Classic SDKs](/developer-guide/classic-api/sdks.md)                                                                                  |
| Connect workspace data and external systems       | [Data & World Model](/developer-guide/platform-api/data-world-model.md) and [Integrations](/developer-guide/platform-api/integrations.md)                                                              |
| Query Classic organization data                   | [Data Access](/developer-guide/classic-api/data-access.md)                                                                                                                                             |
| Inspect runtime outcomes                          | [Runs](/developer-guide/platform-api/conversations/runs.md), [Operators](/developer-guide/platform-api/conversations/operators.md), and [Safety & Monitoring](/developer-guide/platform-api/safety.md) |
| Maintain an existing deployment                   | [Best Practices](/developer-guide/operations/devops.md), with each page's API and CLI scope                                                                                                            |
| Check terminology or compatibility                | [Reference](/developer-guide/operations/reference.md) and [Change Logs](https://docs.concurrence.com/api-reference/change-logs)                                                                        |

## Support and Resources

Investigate an incomplete result with [Troubleshooting](/developer-guide/guides/troubleshooting.md). Before changing an existing integration, review [Current Upgrade Guidance](https://docs.concurrence.com/api-reference/change-logs/upgrade-guide).

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 Concurrence representative through your agreed support channel. Report SDK issues in the relevant package repository: [Platform TypeScript](https://github.com/concurrence-hq/concurrence-platform-typescript-sdk/issues), [Classic TypeScript](https://github.com/concurrence-hq/amigo-typescript-sdk/issues), or [Classic Python](https://github.com/concurrence-hq/amigo-python-sdk/issues).


---

# 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/readme.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.