> 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-api.md).

# Platform API Overview

Implement workspace data, agent configuration, conversations, integrations, and operations through the Concurrence Platform API.

The Platform API connects workspace data, configured agents, supported voice and messaging workflows, integrations, and operational controls. Start with the resource that owns your task, then follow its endpoint contract and lifecycle guidance.

For the architecture behind these resources, read [Core Concepts](https://docs.concurrence.com/platform-overview/core-concepts). The [Getting Started guide](/developer-guide/getting-started.md) covers the initial integration sequence.

## Base URL

Use the regional hostname assigned to your deployment. `https://platform.api-us.concurrence.com` is the US default; it does not route a workspace to another region. HTTP paths in the public schema include the `/v1` prefix. SDK `baseUrl` configuration takes the origin without that prefix.

See [Regions & Endpoints](/developer-guide/getting-started/regions-and-endpoints.md) for regional configuration. Confirm access to any separate test deployment with your Concurrence representative.

## Authentication

Workspace API keys can authenticate supported workspace resource routes as Bearer credentials. Interactive identity, external-user sessions, and machine-to-machine authorization have separate flows and scopes. Health routes can be unauthenticated. Follow [Authentication & API Keys](/developer-guide/platform-api/platform-api/authentication.md) and the specific resource guide instead of applying one credential rule to every endpoint.

## Workspace-Scoped Design

Workspace-scoped resources enforce the credential's access to the workspace in the path. Account, identity, and workspace-management operations have their own boundaries. Creating a workspace does not automatically provision a channel, load source data, or configure a service.

An association with a Classic organization does not make the two APIs' IDs or credentials interchangeable. Use the API and resource names in the [implementation map](/developer-guide/getting-started/core-concepts.md).

## Resource Guide

Use these groups to find the implementation path. The sidebar includes the detailed pages for each resource.

### Authentication & Platform

Authentication and protocol guides. Their scope depends on the route.

{% content-ref url="/pages/pgUT371DPqo400yNGm8c" %}
[Authentication & API Keys](/developer-guide/platform-api/platform-api/authentication.md)
{% endcontent-ref %}

* [OAuth2 (Machine-to-Machine)](/developer-guide/platform-api/platform-api/oauth2.md) - token endpoint, scope resolution, and token claims for the `client_credentials` grant
* [OAuth2 Clients](/developer-guide/platform-api/platform-api/oauth2-clients.md) - client registration, scopes, setup allow-lists, and secret rotation
* [Sessions](/developer-guide/platform-api/platform-api/sessions.md) - persistent WebSocket endpoint for low-latency text conversations
* [Pagination](/developer-guide/platform-api/platform-api/pagination.md) - continuation-token and limit/offset pagination styles
* [Health](/developer-guide/platform-api/platform-api/health.md) - unauthenticated endpoints for external health monitors

### Workspaces & Configuration

Workspace setup and the resources that define agent behavior.

{% content-ref url="/pages/u4TQxi28BJWhEKUfNGTC" %}
[Workspaces](/developer-guide/platform-api/workspaces.md)
{% endcontent-ref %}

* [Agents](/developer-guide/platform-api/workspaces/agents.md) - agent identity, guidance, and versioning
* [Skills](/developer-guide/platform-api/workspaces/skills.md) - companion definitions and the state bindings that govern their execution
* [Services](/developer-guide/platform-api/workspaces/services.md) - bind agents and context graphs into deployable units with version sets
* [Use Cases & Bindings](/developer-guide/platform-api/workspaces/use-cases.md) - channel use cases and service bindings
* [Scheduling Rule Sets](/developer-guide/platform-api/workspaces/scheduling-rule-sets.md) - deterministic appointment slot filtering rules
* [Voice Configuration](/developer-guide/platform-api/workspaces/voice-configuration.md) - per-service voice pipeline tuning
* [Client Config](/developer-guide/platform-api/workspaces/client-config.md) - client-safe configuration values for browser-side apps

### Conversations & Channels

Runtime conversation surfaces across phone, text, and web.

{% content-ref url="/pages/js8kvebm1nrcYWgMPlI0" %}
[Conversations](/developer-guide/platform-api/conversations.md)
{% endcontent-ref %}

* [Channels](/developer-guide/platform-api/conversations/channels.md) and [Channel Manager](/developer-guide/platform-api/conversations/channel-manager.md) - channel provisioning and routing
* [Calls](/developer-guide/platform-api/conversations/calls.md) and [Voice Agent](/developer-guide/platform-api/conversations/voice-agent.md) - voice call records and the real-time voice pipeline
* [SMS](/developer-guide/platform-api/conversations/sms.md) - managed message sending, consent boundaries, and delivery evidence
* [Runs](/developer-guide/platform-api/conversations/runs.md) - unified run inventory and channel-neutral controls
* [Surfaces](/developer-guide/platform-api/conversations/surfaces.md) - agent-generated data collection forms
* [Operators](/developer-guide/platform-api/conversations/operators.md) - operator escalation and takeover
* [SSE Events](/developer-guide/platform-api/conversations/sse-events.md) and [Observer Events](/developer-guide/platform-api/conversations/observer-events.md) - streaming event schemas
* [Serve an Agent From a Web App](/developer-guide/platform-api/conversations/serve-agent-from-web-app.md) - embed an agent in your own web application

### Platform Functions & Tools

Data functions and tools the agent can call mid-conversation.

{% content-ref url="/pages/P8dU1ncnfOC4sR6Kd7IU" %}
[Platform Functions](/developer-guide/platform-api/functions.md)
{% endcontent-ref %}

* [Workspace Data Queries](/developer-guide/platform-api/functions/workspace-data-queries.md) - parameterized SQL templates over workspace tables
* [Tool Testing](/developer-guide/platform-api/functions/tool-testing.md) - resolve and execute context graph tools in isolation
* [Triggers](/developer-guide/platform-api/functions/triggers.md) - schedule recurring actions or fire them from external systems
* [MCP Server](/developer-guide/platform-api/functions/mcp-server.md) - workspace-scoped Model Context Protocol surface for external clients
* [Harness Context](/developer-guide/platform-api/functions/harness-context.md) - read-only service bootstrap context

### Integrations

Connecting agents to external systems and external users to agents.

{% content-ref url="/pages/8XgxpLXbTwEa0DfgJstX" %}
[Integrations](/developer-guide/platform-api/integrations.md)
{% endcontent-ref %}

* [Approval-Gated Integration Writes](/developer-guide/platform-api/integrations/approval-gated-integration-writes.md) - supported conversation-scoped approval
* [Review Queue](/developer-guide/platform-api/integrations/review-queue.md) - stored external write proposals and review decisions
* [External Integrations](/developer-guide/platform-api/integrations/external-integrations.md) - scoped credentials for third-party session creation
* [External Principals](/developer-guide/platform-api/integrations/external-principals.md) - entity-anchored, role-scoped tool access for external users
* [External User Subject-Key Binding](/developer-guide/platform-api/integrations/external-user-subject-key-binding.md) - bind verified external identity into integration auth

### Data & World Model

The event-sourced patient data store and its ingestion paths.

{% content-ref url="/pages/UZmj9knjuYak24tQk90Y" %}
[Data & World Model](/developer-guide/platform-api/data-world-model.md)
{% endcontent-ref %}

* [Entity Resolve](/developer-guide/platform-api/data-world-model/entity-resolve.md) - entity lookup and current resolution boundaries
* [Bulk Import](/developer-guide/platform-api/data-world-model/bulk-import.md) - migration-oriented ingestion
* [Workspace Tables](/developer-guide/platform-api/data-world-model/workspace-tables.md) - workspace-owned custom data tables
* [Customer Data Intake](/developer-guide/platform-api/data-world-model/intake.md) and [Intake Sources](/developer-guide/platform-api/data-world-model/intake-sources.md) - dataset file ingestion and source discovery
* [Intake Upload Links](/developer-guide/platform-api/data-world-model/intake-links.md) - dataset intake does not issue shareable upload links
* [Connector Runner](/developer-guide/platform-api/data-world-model/connector-runner.md) - data-source records and pipeline reads
* [FHIR](/developer-guide/platform-api/data-world-model/fhir.md) - FHIR clinical data endpoints
* [Data Access (MCP)](/developer-guide/platform-api/data-world-model/data-mcp.md) - standalone SQL access for external MCP clients using Classic API organization credentials

### Scribe

[Scribe](/developer-guide/platform-api/scribe.md) serves provider documentation workflows through a separately configured deployment. Follow its [sessions](/developer-guide/platform-api/scribe/sessions.md) and [artifacts](/developer-guide/platform-api/scribe/artifacts.md) guides for provider ownership, credentials, and completion behavior.

### Safety & Monitoring

Runtime safety, quality evaluation, and observability.

{% content-ref url="/pages/eN4MWcO2S0Wu6cGRs2Fo" %}
[Safety & Monitoring](/developer-guide/platform-api/safety.md)
{% endcontent-ref %}

* [Analytics & Observability](/developer-guide/platform-api/safety/analytics.md) - call analytics and quality trends
* [Insights](/developer-guide/platform-api/safety/insights.md) and [Metric Store](/developer-guide/platform-api/safety/metric-store.md) - derived metrics and storage
* [Call Trace Analysis](/developer-guide/platform-api/safety/call-trace-analysis.md) and [Voice Judge](/developer-guide/platform-api/safety/voice-judge.md) - per-call evaluation
* [Production Evals](/developer-guide/platform-api/safety/production-evals.md) and [Simulation Coverage](/developer-guide/platform-api/safety/simulation-coverage.md) - evaluation pipelines
* [Prompt Logs](/developer-guide/platform-api/safety/prompt-logs.md) - full LLM input/output for auditing and debugging
* [Trace Export](/developer-guide/platform-api/safety/trace-export.md) - exporting traces for offline analysis

{% hint style="info" %}
**Classic API features not in Platform API.** Dynamic Behaviors (rule-based triggers) and User Management are available only through the [Classic API](/developer-guide/classic-api/core-api.md). The Platform API has its own testing and evaluation surfaces - [Simulation Coverage](/developer-guide/platform-api/safety/simulation-coverage.md), [Production Evals](/developer-guide/platform-api/safety/production-evals.md), and the [Metric Store](/developer-guide/platform-api/safety/metric-store.md) - and handles user context through the [World Model](/developer-guide/platform-api/data-world-model.md).
{% endhint %}

## Pagination

Most resource list endpoints use continuation-token pagination (`items`, `has_more`, `continuation_token`, optional `total`); a fixed set of endpoint groups uses `limit`/`offset` instead. See [Pagination](/developer-guide/platform-api/platform-api/pagination.md) for both styles, the limit/offset endpoint list, and per-endpoint limits.

## API Reference

For full endpoint schemas, see the auto-generated [Platform API Reference](https://docs.concurrence.com/api-reference/readme/platform).


---

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