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

# Channel Field • AI Agent SDK

> ChannelField: A single configuration field a channel plugin declares about itself.

# ChannelField

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

AI Agent

A single configuration field a channel plugin declares about itself.

A channel adapter attaches a list of these (via `ChannelDescriptor`) so
the gateway can wire its config schema, onboarding wizard, and env-var
fallbacks with zero core edits. Without this, a plugin channel's own keys
(e.g. IRC's `server` / `nickserv_password`) are silently dropped by the
fixed `ChannelConfigSchema` under Pydantic's `extra="ignore"` default.

Attributes:
name: Config key name (as it appears under `channels.<platform>`).
required: Whether the field must be provided.
secret: Whether the value is sensitive (masked in prompts/logs).
prompt: Human-friendly prompt shown by the onboarding wizard.
env: Optional environment-variable name used as a fallback source.

## Properties

**name** `str`

No description available.

**required** `bool`

No description available.

**secret** `bool`

No description available.

**prompt** `str`

No description available.

**env** `Optional[str]`

No description available.

> [accordion] Internal & Generic Methods
>
> * **to\_dict**: Convert to dictionary.

## Source

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


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