WebSocket API

Real-time client integration for custom apps, dashboards, and frontends.

The WebSocket interface is the best connector for custom clients.

It gives you bidirectional, low-latency messaging with the same agent runtime used by chat platforms.

Best for

• Browser apps

• Internal dashboards

• Mobile clients

• Custom chat UIs

Message shape

Send JSON objects with a type field.

Typical message types are message, reply, ping, pong, and error.

Auth model

When gateway auth is enabled, send the gateway token in the message payload.