> ## Documentation Index
> Fetch the complete documentation index at: https://developer.communicate.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Communicate Developer Platform

> Manage workspaces, agents and knowledge through the Communicate API and CLI.

Build and automate your Communicate workflows with scoped credentials, a public REST API and the published Communicate CLI. Connect MCP clients to scoped management tools with read and write permissions.

<CardGroup cols={2}>
  <Card title="Start with the CLI" icon="terminal" href="/docs/cli">
    Install the published package, authenticate without a browser and run named management commands.
  </Card>

  <Card title="Explore the API" icon="code" href="https://app.communicate.so/api/v1/openapi.json">
    Use the canonical OpenAPI contract to discover operations, inputs, credentials and scopes.
  </Card>

  <Card title="Choose authentication" icon="key" href="/docs/authentication">
    Use account credentials for management or workspace OAuth tokens for agent discovery and chat.
  </Card>

  <Card title="Connect an MCP client" icon="bot" href="/docs/mcp">
    Configure the remote Streamable HTTP endpoint with a resource-bound access token.
  </Card>
</CardGroup>

## Available now

The v0.1.5 API and CLI increment supports:

* Account credential bootstrap, listing, creation, editing, rotation and revocation.
* Workspace creation and settings, members, invitations, teams and team membership.
* Agent creation, configuration, discovery, setup checks and duplication.
* Knowledge sources: creation, file upload, inspection, content editing, retraining, refresh and removal.
* Source improvement suggestions, learning review and Grill workflows.
* Personal notification devices, preferences, visibility settings and test-send acceptance.
* Custom actions and atomic action batches.
* Scheduling integrations with API keys, personal access tokens and explicit Calendly consent.
* In-app campaign creation, editing, duplication, publication, pausing and archival; image upload preparation and confirmation.
* Outbound campaign draft creation, listing, scheduled pausing and removal.
* Inbox tickets: review, internal notes, labels, reply retry, attachments, copilot suggestions and live support requests.
* Contact profiles: creation, search and management.
* Agent saved replies, automation rules, support settings and signatures, help-center articles, grants and contacts.
* Linked agents and linked conversations, including linked copilot, attachments and analytics.
* Workspace labels, custom domains, webhooks and support request lifecycle with SLA commands.
* Agent, workspace and in-app analytics reads; billing reads; account preferences.

Workspace-scoped integrations can also list agents and send grounded support chat turns with citations and conversation continuity.

<Note>
  This is an incremental release. Destructive, billing-change, sharing, transfer, API-key and compliance workflows remain in progress. MCP management tools use explicitly scoped account credentials; legacy workspace OAuth remains read-only. Check the deployed [capability response](https://app.communicate.so/api/v1/capabilities) and each operation's API reference before relying on a workflow.
</Note>

## Install the CLI

```bash theme={null}
npm install --global @communicate_so/cli
communicate --version
communicate --help
```

See the [CLI guide](/docs/cli) for secure authentication, input files, examples and automation output.

## Base URL

```text theme={null}
https://app.communicate.so/api/v1
```

## First management request

Use a scoped account credential obtained through the [headless bootstrap workflow](/docs/cli#authenticate-without-a-browser). Supply it through your secret manager:

```bash theme={null}
curl https://app.communicate.so/api/v1/workspaces \
  -H "Authorization: Bearer $COMMUNICATE_TOKEN"
```

For workspace agent discovery and chat, follow the separate [workspace integration quickstart](/docs/quickstart).

## Machine-readable contract

* [Canonical OpenAPI 3.2.1 contract](https://app.communicate.so/api/v1/openapi.json)
* [Live capability discovery](https://app.communicate.so/api/v1/capabilities)
* [Published CLI package](https://www.npmjs.com/package/@communicate_so/cli)
* [Website developer guide](https://communicate.so/developers)
* [Agent discovery](https://communicate.so/.well-known/agent.json)

Need help? Email [communicate@support.communicate.so](mailto:communicate@support.communicate.so).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.