Send an event

post

{apiUrl}/ca/v1/agents/{agentId}/chats/{chatId}/send-event

Send one event to the chat and receive a streaming JSON array of events in response.

The response stream includes the same user event that the client sent. If the UI already rendered that message optimistically, ignore the streamed copy with the same id to avoid showing the shopper's message twice.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

agentId

string

required

chatId

string

required

Generated by the client (UUID v7). A chat does not have to exist: its first turn on send-event creates it under the project and persona (agent) this request addresses. A chatId that already exists under another project or persona answers 404 with { "code": "CHAT_SCOPE_MISMATCH" }; the client should then start over with a new chatId. history answers the same body for a chat that has not been created yet, so a client regenerates its chatId on the code from send-event only.

Body Params

event

required

url

string

required

localeTime

string | null

apple

number | null

endCustomerId

string | null

conversationId

string | null

directToAgent

boolean | null

testerGroup

string | null

enum

Allowed:

agentPayload

object | null

openingInputs

array of objects | null

Optional, on the first turns of a chat: the ADD_MESSAGE.ASSISTANT.COLD_START events the client is showing, oldest first. When the greeting the server kept has expired, the newest one is run again and stored in front of the conversation. Entries that are not cold-start events are ignored; the field never fails a request.

openingInputs

Responses

429

Too Many Requests — rate limit exceeded. Back off before retrying.

500

Internal Server Error — backend error.

200200 response

400Bad Request — invalid event format or missing required field (ValidationError body).

404Not Found — unknown agentId (empty body), or a chatId that exists under another agent (CHAT_SCOPE_MISMATCH body).