# communicate-so Agents API

**Canonical:** https://apis.io/apis/communicate-so/communicate-so-agents-api/  
**Provider:** communicate-so — https://apis.io/providers/communicate-so/  
**Base URL:** https://app.communicate.so/api/v1  
**Documentation:** https://communicate.so/developers

communicate-so Agents API is one of 14 APIs that [communicate-so](https://apis.io/providers/communicate-so/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The Agents API from communicate-so — 73 operation(s) for agents.

## Operations (60 of 94)

| Method | Path | Summary |
|---|---|---|
| GET | `/workspaces/{workspaceId}/members/{memberId}/agents` | Read a member agent allow-list |
| PUT | `/workspaces/{workspaceId}/members/{memberId}/agents` | Replace a member agent allow-list |
| GET | `/workspaces/{workspaceId}/analytics/agents/{agentId}` | Read one agent analytics for the last N days |
| GET | `/workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/summary` | Read the analytics summary for one agent |
| GET | `/workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/surface` | Read which analytics views are available for one agent |
| GET | `/workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/reports/{report}` | Read one analytics report for one agent |
| GET | `/workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/classification/policy` | Read the topic classification policy for one agent |
| PUT | `/workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/classification/policy` | Set how conversations are classified for analytics |
| GET | `/workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/classification/jobs/{jobId}` | Read the status of one topic classification job |
| GET | `/workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/exports/{artifactId}` | Read the status of one analytics export |
| GET | `/workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/drilldown` | Read the conversations behind an agent analytics view |
| GET | `/workspaces/{workspaceId}/agents/{agentId}/source-suggestions` | Review source health and coverage gaps, including sampled visitor questions |
| GET | `/workspaces/{workspaceId}/agents/models` | List available models and workspace plan eligibility |
| GET | `/workspaces/{workspaceId}/agents` | List accessible workspace agents and activity counts |
| POST | `/workspaces/{workspaceId}/agents` | Create an agent with explicit settings |
| GET | `/workspaces/{workspaceId}/agents/{agentId}/support/help-center/articles` | List help-center articles for an agent |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/support/help-center/articles` | Write a help-center article |
| PATCH | `/workspaces/{workspaceId}/agents/{agentId}/support/help-center/articles/{articleId}` | Edit a help-center article |
| DELETE | `/workspaces/{workspaceId}/agents/{agentId}/support/help-center/articles/{articleId}` | Delete a help-center article and untrain it |
| GET | `/workspaces/{workspaceId}/agents/{agentId}/grants` | List the workspaces this agent is shared with |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/grants` | Share this agent with another workspace by email |
| GET | `/workspaces/{workspaceId}/agents/{agentId}` | Read an accessible agent and its settings |
| PUT | `/workspaces/{workspaceId}/agents/{agentId}` | Update supplied agent settings; supplied nested configurations replace their… |
| GET | `/workspaces/{workspaceId}/agents/{agentId}/setup` | Read actual agent setup completion |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/logo/fetch` | Set the agent logo from a website favicon (the supplied website or the saved… |
| GET | `/workspaces/{workspaceId}/agents/voice/catalog` | List available voice options and whether voice runtime is enabled |
| GET | `/workspaces/{workspaceId}/agents/{agentId}/contacts` | List the distinct widget visitors who have talked to an agent |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/chat` | Send a playground test message to an agent; spends workspace credits like any… |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/duplicate` | Duplicate an agent configuration and training sources as a draft |
| GET | `/workspaces/{workspaceId}/agents/{agentId}/support/macros` | List saved replies for an agent with this month's use counts |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/support/macros` | Create a saved reply; names are unique per agent |
| PATCH | `/workspaces/{workspaceId}/agents/{agentId}/support/macros/{macroId}` | Update supplied saved reply fields |
| DELETE | `/workspaces/{workspaceId}/agents/{agentId}/support/macros/{macroId}` | Delete a saved reply |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/support/macros/{macroId}/uses` | Record that the caller inserted a saved reply |
| GET | `/workspaces/{workspaceId}/agents/{agentId}/support/rules` | List an agent's automation rules in run order with weekly fire counts |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/support/rules` | Create an automation rule at the end of the run order |
| PATCH | `/workspaces/{workspaceId}/agents/{agentId}/support/rules/{ruleId}` | Update supplied automation rule fields |
| DELETE | `/workspaces/{workspaceId}/agents/{agentId}/support/rules/{ruleId}` | Delete an automation rule |
| PUT | `/workspaces/{workspaceId}/agents/{agentId}/support/rules/order` | Set the run order; send every rule of the agent exactly once |
| PUT | `/workspaces/{workspaceId}/agents/{agentId}/support/rules/loop-guard` | Turn the automation loop guard on or off |
| GET | `/workspaces/{workspaceId}/agents/{agentId}/support/rules/runs` | List the 50 latest rule fires, newest first |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/support/rules/preview` | Dry-run rule conditions against recent conversations without applying them |
| GET | `/workspaces/{workspaceId}/agents/{agentId}/support/settings` | Read assignment, hours, reply targets, email handling, the caller signature and… |
| PUT | `/workspaces/{workspaceId}/agents/{agentId}/support/settings` | Replace support settings; the stored loop guard is kept when automation is… |
| PUT | `/workspaces/{workspaceId}/agents/{agentId}/support/signature` | Set or clear the caller own email signature for this agent |
| GET | `/workspaces/{workspaceId}/agents/{agentId}/actions` | List custom agent actions with credential headers redacted |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/actions` | Create a custom agent action |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/actions/batch` | Atomically create up to twenty custom agent actions |
| PATCH | `/workspaces/{workspaceId}/agents/{agentId}/actions/{actionId}` | Update a custom agent action while preserving omitted headers |
| DELETE | `/workspaces/{workspaceId}/agents/{agentId}/actions/{actionId}` | Delete a custom agent action |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/integrations/calendly/oauth/start` | Start agent-bound Calendly consent with PKCE; completion requires provider… |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/integrations/calendly/oauth/complete` | Exchange agent-bound Calendly consent and persist an encrypted scheduling… |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/integrations` | Validate provider credentials and connect a scheduling integration |
| GET | `/workspaces/{workspaceId}/agents/{agentId}/integrations` | List provider capabilities and permitted Agent connections without credentials |
| PATCH | `/workspaces/{workspaceId}/agents/{agentId}/integrations/{integrationId}` | Update integration enablement, capabilities and merged configuration |
| DELETE | `/workspaces/{workspaceId}/agents/{agentId}/integrations/{integrationId}` | Disconnect an agent integration and remove its unused credential connection |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/integrations/{integrationId}/test` | Revalidate stored provider credentials and update connection verification status |
| GET | `/workspaces/{workspaceId}/agents/{agentId}/outbound-campaigns` | List outbound campaigns for an agent |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/outbound-campaigns` | Create an outbound campaign draft |
| POST | `/workspaces/{workspaceId}/agents/{agentId}/outbound-campaigns/{campaignId}/pause` | Pause a scheduled outbound campaign |

…and 34 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/communicate-so/openapi/communicate-so-agents-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/communicate-so/json-schema/communicate-so-read-inbox-conversation-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/communicate-so/json-schema/communicate-so-list-workspace-agents-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/communicate-so/json-schema/communicate-so-create-agent-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/communicate-so/json-schema/communicate-so-duplicate-agent-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/communicate-so/json-schema/communicate-so-fetch-agent-logo-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/communicate-so/json-schema/communicate-so-read-agent-response-schema.json

## Other communicate-so APIs (12)

- [communicate-so Account credentials API](https://apis.io/apis/communicate-so/communicate-so-account-credentials-api/)
- [communicate-so Account preferences API](https://apis.io/apis/communicate-so/communicate-so-account-preferences-api/)
- [communicate-so Authentication API](https://apis.io/apis/communicate-so/communicate-so-authentication-api/)
- [communicate-so Chat API](https://apis.io/apis/communicate-so/communicate-so-chat-api/)
- [communicate-so Discovery API](https://apis.io/apis/communicate-so/communicate-so-discovery-api/)
- [communicate-so Grill API](https://apis.io/apis/communicate-so/communicate-so-grill-api/)
- [communicate-so Inbox API](https://apis.io/apis/communicate-so/communicate-so-inbox-api/)
- [communicate-so Learnings API](https://apis.io/apis/communicate-so/communicate-so-learnings-api/)
- [communicate-so Notifications API](https://apis.io/apis/communicate-so/communicate-so-notifications-api/)
- [communicate-so Sources API](https://apis.io/apis/communicate-so/communicate-so-sources-api/)
- [communicate-so Teams API](https://apis.io/apis/communicate-so/communicate-so-teams-api/)
- [communicate-so Workspace members API](https://apis.io/apis/communicate-so/communicate-so-workspace-members-api/)

## Tags

Agents

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/communicate-so/communicate-so-agents-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/communicate-so/.