Conversations
Real-time chat session
WebSocket API used in real-time conversations (e.g. those created with chat_realtime).
WSS
wss://agent.app.operator.xyz
conversations
/
{conversation_id}
/
session?token=
{token}
Messages
{
"id": "<string>",
"payload": {
"type": "<string>"
}
}{
"id": "<string>",
"payload": {
"type": "<string>",
"text": "<string>"
}
}No examples found{
"id": "<string>",
"payload": {
"type": "<string>"
}
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>"
},
"experimental": true
}No examples foundNo examples found{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>",
"text_delta": "<string>",
"generation_id": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>",
"text": "<string>",
"interrupted": true,
"has_tool_calls": true,
"generation_id": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>",
"call_id": "<string>",
"name": "<string>",
"arguments": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>",
"call_id": "<string>",
"name": "<string>",
"arguments": "<string>",
"result": "<string>",
"error": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>",
"text": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>",
"error": "<string>",
"source_event_id": "<string>"
},
"experimental": true
}conversation_id
type:string
required
Unique identifier for the conversation, e.g. conv_8qm9JBCiTe7.
token
type:string
required
Ephemeral token returned by the server when the conversation was created.
conversation.start
type:object
Start the conversation.
user.message.send
type:object
Send a message from the user to the agent.
conversation.context.update
type:object
Update the conversation context mid-session.
conversation.end
type:object
End the conversation.
conversation.started
type:object
Sent once the conversation has started.
conversation.setup
type:object
Sent before a conversation starts. This can be used as webhook to preload data relevant to the conversation.
conversation.context.updated
type:object
Indicates the context has been updated on the agent side.
agent.notice.sent
type:object
Agent has sent a system-level notice (e.g. "This call may be recorded").
agent.message.delta
type:object
Streaming partial message content as it's being generated.
agent.message.completed
type:object
Sent when the agent finishes sending a message.
agent.tool_call.created
type:object
Sent when the agent triggers a tool call.
agent.tool_call.returned
type:object
Sent when the tool call returns a result.
user.message.received
type:object
Acknowledgment that the user message was received.
conversation.ended
type:object
Sent when the conversation has ended.
server.error
type:object
Emitted when a server-side error occurs during event handling.
Messages
{
"id": "<string>",
"payload": {
"type": "<string>"
}
}{
"id": "<string>",
"payload": {
"type": "<string>",
"text": "<string>"
}
}No examples found{
"id": "<string>",
"payload": {
"type": "<string>"
}
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>"
},
"experimental": true
}No examples foundNo examples found{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>",
"text_delta": "<string>",
"generation_id": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>",
"text": "<string>",
"interrupted": true,
"has_tool_calls": true,
"generation_id": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>",
"call_id": "<string>",
"name": "<string>",
"arguments": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>",
"call_id": "<string>",
"name": "<string>",
"arguments": "<string>",
"result": "<string>",
"error": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>",
"text": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>"
},
"experimental": true
}{
"id": "<string>",
"created_at": "<string>",
"agent_id": "<string>",
"livemode": true,
"conversation_id": "<string>",
"payload": {
"type": "<string>",
"error": "<string>",
"source_event_id": "<string>"
},
"experimental": true
}Assistant
Responses are generated using AI and may contain mistakes.