> ## 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**](../modules/protocols) module.

<Badge color="blue">AI Agent</Badge>

Protocol for channel/topic-based push messaging.

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

## Methods

<CardGroup cols={2}>
  <Card title="add_channel()" icon="function" href="../functions/PushChannelProtocol-add_channel">
    Create a named channel.
  </Card>

  <Card title="remove_channel()" icon="function" href="../functions/PushChannelProtocol-remove_channel">
    Delete a channel and unsubscribe all clients.
  </Card>

  <Card title="get_channel()" icon="function" href="../functions/PushChannelProtocol-get_channel">
    Get channel metadata.
  </Card>

  <Card title="list_channels()" icon="function" href="../functions/PushChannelProtocol-list_channels">
    List all active channel names.
  </Card>

  <Card title="subscribe_client()" icon="function" href="../functions/PushChannelProtocol-subscribe_client">
    Subscribe a client to a channel.
  </Card>

  <Card title="unsubscribe_client()" icon="function" href="../functions/PushChannelProtocol-unsubscribe_client">
    Unsubscribe a client from a channel.
  </Card>

  <Card title="get_subscribers()" icon="function" href="../functions/PushChannelProtocol-get_subscribers">
    List client IDs subscribed to a channel.
  </Card>

  <Card title="get_client_channels()" icon="function" href="../functions/PushChannelProtocol-get_client_channels">
    List channels a client is subscribed to.
  </Card>

  <Card title="publish_to_channel()" icon="function" href="../functions/PushChannelProtocol-publish_to_channel">
    Publish an event to all subscribers of a channel.
  </Card>
</CardGroup>

## Source

<Card title="View on GitHub" icon="github" href="https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/gateway/protocols.py#L1276">
  `praisonaiagents/gateway/protocols.py` at line 1276
</Card>