Decode Client Frame • AI Agent SDK

decode_client_frame: Validate a raw inbound frame into a typed, discriminated client frame.

decode_client_frame

Function

</div>

This function is defined in the protocols module.

Validate a raw inbound frame into a typed, discriminated client frame.

This is the single source of truth for the gateway wire contract: it decodes every advertised inbound method (`hello, message, leave) and the legacy join handshake into a validated dataclass, or raises :class:FrameDecodeError carrying a structured :class:HelloError` for the transport to reject with. Field coercion/validation happens once, here, at the WebSocket boundary — handlers receive already-typed objects.

Signature

python

def decode_client_frame(data: Dict[str, Any]) -> ClientFrame

Parameters

ParamField Dict[str, Any]

The raw, JSON-decoded inbound frame (discriminated on `type`).

Returns

ResponseField ClientFrame

class:HelloParams, :class:MessageParams, :class:LeaveParams, or :class:JoinParams.

Exceptions

FrameDecodeError

When `data` is not a mapping, carries an unknown /

Uses

FrameDecodeError
HelloError
MessageParams.from_frame
LeaveParams.from_frame
JoinParams.from_frame

Source

View on GitHub

praisonaiagents/gateway/protocols.py at line 1053

Decode Client Frame • AI Agent SDK