Agents

Send a playground test message to an agent; spends workspace credits like any chat

Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.

post/workspaces/{workspaceId}/agents/{agentId}/chat

Request

  • Base URL: https://app.communicate.so/api/v1
  • URL: https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/chat
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Secure-better-auth.session_token
    • API key in cookie better-auth.session_token

Path parameters

workspaceIdstring required
agentIdstring required

Request body

messagestring required
requestIdstring uuid
conversationIdstring nullable
enabledActionIdsstring[]
timeZonestring

Response

Send a playground test message to an agent; spends workspace credits like any chat

ChatWithAgentPreviewResponse required

Changes

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