> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Decode Client Frame • AI Agent SDK

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

# decode\_client\_frame

Function

> This function is defined in the [**protocols**](https://praison.ai/docs/sdk/reference/praisonaiagents/modules/protocols.md) 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 theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
def decode_client_frame(data: Dict[str, Any]) -> ClientFrame
```

## Parameters

**data** `Dict[str, Any]` *required*

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

### Returns

**Returns** `ClientFrame`

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

### Exceptions

> [accordion] FrameDecodeError
>
> When `data` is not a mapping, carries an unknown /

## Uses

* `FrameDecodeError`
* `HelloError`
* `MessageParams.from_frame`
* `LeaveParams.from_frame`
* `JoinParams.from_frame`

## Source

> [card] [View on GitHub](https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/gateway/protocols.py#L1053)
>
> `praisonaiagents/gateway/protocols.py` at line 1053

***

## Related Documentation

> [card] [Code Agent](https://praison.ai/docs/docs/features/codeagent)

> [card] [Code Feature](https://praison.ai/docs/docs/features/code)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.