Skip to main content

auth/connect

Authenticate a WebSocket connection. Must be the first message on a new connection.

Parameters

jwt
string
The jwt field.
minProtocol
string
The minProtocol field.
maxProtocol
string
The maxProtocol field.
agentKey
string
The agentKey field.

Response

Connection metadata including agent ID, protocol version, conversations, and server policy.
protocolVersion
string
The protocolVersion field.
userId
string (UUID)
Branded UserId
userDisplayName
string
The userDisplayName field.
agentId
string (UUID)
Branded AgentId
conversations
array
The conversations field.
unreadCounts
object (map)
The unreadCounts field.
policy
object
The policy field.
ownedAgents
array
The ownedAgents field.
activeAgentId
string (UUID)
Branded AgentId

Errors

CodeNameWhen
-32000UnauthorizedInvalid API key or JWT
-32008ProtocolMismatchClient protocol version not supported