Agents

List agents in the API key workspace

Returns the agents visible to the authenticated workspace API key. This route is non-streaming and shares the public API group rate limit of 600 requests per minute per key.

get/agents

Request

  • Base URL: https://app.communicate.so/api/v1
  • URL: https://app.communicate.so/api/v1/agents
  • Auth: one of:
    • OAuth 2 (client credentials, token URL https://app.communicate.so/api/v1/oauth/token, scopes: agents:read)
    • HTTP bearer

Response

Workspace agents

idstring required
namestring required
status'active' | 'inactive' | 'draft' required

Changes

No recorded changes to this operation across all 1 revision of this API.