Chat

Send a chat turn to an agent

Creates or continues an API-channel conversation and returns one complete response payload. This endpoint does not stream. requestId is optional idempotency; reusing it with different input yields 409 request_id_conflict. Chat turns are additionally rate-limited to 60 requests per minute per key. Responses may include grounded citations and, when an action ran, actionName.

post/agents/{agentId}/chat

Request

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

Path parameters

agentIdstring required

The target agent identifier.

Request body

messagestring required

End-user prompt sent to the agent.

requestIdstring uuid

Optional idempotency key for safe retries of the same chat input.

conversationIdstring nullable

Continue an existing API-channel conversation when present.

Response

Completed non-streaming chat response

conversationIdstring required
ticketNumberinteger nullable
messageIdstring required
userMessageIdstring required
answerstring required
mode'ai' | 'human' required
actionNamestring

Present when a workspace action produced the final answer.

followUpsstring[]

Optional suggested next questions returned with the answer.

Changes

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