> ## 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.

# Push Channel Protocol • AI Agent SDK

> PushChannelProtocol: Protocol for channel/topic-based push messaging.

# PushChannelProtocol

> Defined in the [**protocols**](https://praison.ai/docs/sdk/reference/praisonaiagents/modules/protocols.md) module.

AI Agent

Protocol for channel/topic-based push messaging.

Channels group clients by interest. Messages published to a channel
are delivered to all subscribed clients.

## Methods

> [card] [add\_channel()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/PushChannelProtocol-add_channel.md)
>
> Create a named channel.

> [card] [remove\_channel()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/PushChannelProtocol-remove_channel.md)
>
> Delete a channel and unsubscribe all clients.

> [card] [get\_channel()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/PushChannelProtocol-get_channel.md)
>
> Get channel metadata.

> [card] [list\_channels()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/PushChannelProtocol-list_channels.md)
>
> List all active channel names.

> [card] [subscribe\_client()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/PushChannelProtocol-subscribe_client.md)
>
> Subscribe a client to a channel.

> [card] [unsubscribe\_client()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/PushChannelProtocol-unsubscribe_client.md)
>
> Unsubscribe a client from a channel.

> [card] [get\_subscribers()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/PushChannelProtocol-get_subscribers.md)
>
> List client IDs subscribed to a channel.

> [card] [get\_client\_channels()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/PushChannelProtocol-get_client_channels.md)
>
> List channels a client is subscribed to.

> [card] [publish\_to\_channel()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/PushChannelProtocol-publish_to_channel.md)
>
> Publish an event to all subscribers of a channel.

## Source

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


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