API ReferenceConversations

Update conversation AI status

Pause or resume AI replies.

PATCH
/api/v1/console/agents/{agentId}/conversations/{conversationId}/ai-status

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Team API key (prefix sk_). You may also send the key via X-Api-Key header.

In: header

Path Parameters

agentId*string
conversationId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/api/v1/console/agents/string/conversations/string/ai-status" \  -H "Content-Type: application/json" \  -d '{    "is_ai_chat_paused": true  }'
{  "message": "Success",  "data": {    "is_ai_chat_paused": true  }}

Send message to conversation

Send a user or assistant message to an existing conversation.

Stream messages (SSE)

Server-Sent Events stream of new messages for a conversation. Authenticate with a ?ticket= obtained from POST .../stream-ticket. Supports reconnect via Last-Event-ID header or ?after=<chatId|ISO>. Emits "message" and periodic "heartbeat" events.