For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
BlogLogin
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
      • WSSwebsocketChat
LogoLogo
BlogLogin
API ReferenceWebsocket Chat

websocketChat

WSS
wss://api.flockx.io/api/v2/websockets/:channel_id?ticket=:ticket
Handshake
URLwss://api.flockx.io/api/v2/websockets/undefined?ticket=undefined
MethodGET
Status101 Switching Protocols
Messages
Was this page helpful?
Previous
Built with

Handshake

WSS
wss://api.flockx.io/api/v2/websockets/:channel_id?ticket=:ticket

Query parameters

channel_idstringRequired
The channel ID for the chat
ticketstringRequired
The authentication ticket for the chat channel

Send

sendMessageobjectRequired
Send message in the chat from a human.

Receive

receiveMessageobjectRequired
Receive a message in the chat from an AI agent.