Skip to main content

WebSocket API

The WebSocket API offers real-time, bidirectional communication with Dexto. Use this for building highly interactive applications.

Connection URL​

ws://localhost:3000/

The port may vary based on your server configuration.

Client → Server Messages​

Send these messages to the server as JSON-formatted strings to control the agent.

message​

Instructs the agent to process a user prompt.

{
  "type": "message",
  "content": "Your prompt here",
  "sessionId": "optional-session-id",
  "stream": true,
  "imageData": { "base64": "...", "mimeType": "image/jpeg" },
  "fileData": { "base64": "...", "mimeType": "application/pdf", "filename": "doc.pdf" }
}

reset​

Resets the conversation history for a given session.

{
  "type": "reset",
  "sessionId": "optional-session-id"
}

Server → Client Events​

Listen for these events from the server. All events follow the { "event": "EVENT_NAME", "data": { ... } } structure.

EventData PayloadDescription
thinking{ sessionId }The agent has received the prompt and started processing.
chunk{ text, isComplete?, sessionId }A part of the agent's response when stream is true.
response{ text, tokenCount?, model?, sessionId }The final, complete response from the agent.
toolCall{ toolName, args, callId?, sessionId }Informs that the agent is about to execute a tool.
toolResult{ toolName, result, callId?, success, sessionId }Provides the result from a tool's execution.
conversationReset{ sessionId }Conversation history cleared for session.
mcpServerConnected{ name, success, error? }MCP server connection result.
availableToolsUpdated{ tools, source }Available tools changed.
toolConfirmationRequest{ ... }Request to confirm a tool execution.
error{ message, context?, recoverable?, sessionId }An error occurred during message processing.