communicate-so

communicate-so Agents API

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

GitHub OpenAPI

Operations 94

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 #
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 #
DELETE /workspaces/{workspaceId}/agents/{agentId}/outbound-campaigns/{campaignId} Delete an outbound campaign after pausing if scheduled #
POST /workspaces/{workspaceId}/agents/{agentId}/in-app/images/presign Prepare an agent-owned in-app image upload #
POST /workspaces/{workspaceId}/agents/{agentId}/in-app/images/confirm Validate an uploaded agent-owned image and obtain its managed URL #
POST /workspaces/{workspaceId}/agents/{agentId}/in-app Create an in-app campaign with native authoring validation #
GET /workspaces/{workspaceId}/agents/{agentId}/in-app List in-app campaigns for an agent #
PATCH /workspaces/{workspaceId}/agents/{agentId}/in-app/{nudgeId} Edit in-app campaign authoring fields in place #
GET /workspaces/{workspaceId}/agents/{agentId}/in-app/{nudgeId} Read an in-app campaign and its stored authoring fields #
DELETE /workspaces/{workspaceId}/agents/{agentId}/in-app/{nudgeId} Delete an untouched draft or archive a campaign with history #
GET /workspaces/{workspaceId}/agents/{agentId}/in-app/{nudgeId}/analytics Read views, clicks and dismissals for one in-app campaign #
POST /workspaces/{workspaceId}/agents/{agentId}/in-app/{nudgeId}/duplicate Copy an in-app campaign into a new draft #
POST /workspaces/{workspaceId}/agents/{agentId}/deletion/request Email the workspace owner a 6-digit code to delete this agent #
POST /workspaces/{workspaceId}/agents/{agentId}/deletion/confirm Schedule agent deletion with the emailed 6-digit code #
POST /workspaces/{workspaceId}/agents/{agentId}/deletion/cancel Cancel a scheduled agent deletion #
PATCH /workspaces/{workspaceId}/agents/{agentId}/grants/{grantId}/permission Change what a linked workspace may do with this agent #
POST /workspaces/{workspaceId}/agents/{agentId}/grants/{grantId}/resend Resend a pending share invitation #
POST /workspaces/{workspaceId}/agents/{agentId}/grants/{grantId}/cancel Cancel a pending share invitation #
POST /workspaces/{workspaceId}/agents/{agentId}/grants/{grantId}/revoke Revoke an accepted share #
GET /workspaces/{workspaceId}/agents/{agentId}/transfer/preview Show what an agent transfer would move #
POST /workspaces/{workspaceId}/agents/{agentId}/transfer Offer this agent to another account by email; nothing moves until they accept #
POST /workspaces/{workspaceId}/agents/{agentId}/transfer/{transferId}/cancel Cancel a pending outgoing agent transfer #
POST /workspaces/{workspaceId}/agents/{agentId}/voice/sessions Open a dashboard playground voice session; spends voice credits #
GET /workspaces/{workspaceId}/agents/{agentId}/support/widget-identity Read widget identity verification settings, including the signing secret for… #
PUT /workspaces/{workspaceId}/agents/{agentId}/support/widget-identity Turn widget identity verification or history merging on or off #
POST /workspaces/{workspaceId}/agents/{agentId}/support/widget-identity/rotate Replace the widget identity signing secret; the old one stops working #
POST /workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/classification/jobs Classify past conversations for analytics; may spend credits #
POST /workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/classification/manual Set the analytics classification of one conversation by hand #
POST /workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/topics/{canonicalTopicId}/rename Rename an analytics topic #
POST /workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/topics/{canonicalTopicId}/archive Archive an analytics topic #
POST /workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/topics/merge Merge analytics topics into one #
POST /workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/topics/reprocess/preview Preview the cost of regrouping conversations into topics #
POST /workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/topics/reprocess/confirm Regroup conversations into topics; spends credits #
POST /workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/topics/reprocess/status Read the progress of a topic regroup #
POST /workspaces/{requestingWorkspaceId}/agents/{agentId}/analytics/topics/reprocess/cancel Cancel a running topic regroup #
GET /agents List agents in the API key workspace #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/communicate-so/openapi/communicate-so-agents-api-openapi.yml

Schemas & Data

📊
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/communicate-so:communicate-so-agents-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

communicate-so-agents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Communicate So Agents API
  version: 0.1.5
  description: 'Operations tagged Agents across 2 of this provider''s published API definitions: communicate-so-openapi.json, communicate-so-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.communicate.so/api/v1
  description: Canonical external base URL served through the Next.js /api/v1 rewrite.
security:
- oauth2: []
- bearerAuth: []
tags:


# --- truncated at 32 KB (429 KB total) ---
# Full source: https://artifacts.apis.io/communicate-so/openapi/communicate-so-agents-api-openapi.yml