Add an A2A channel (returns plaintext key once).

POST

/v1/apps/{app_id}/a2a-channels

• Production API

Parameters

Path Parameters

app_id

required

string

App ID

Request Body ^required

object

agent_card_description

string | null

agent_card_name

string | null

enabled

boolean | null

message

required

string

session_mode

How app-triggered invocations route into sessions.

string

Allowed values: shared_session session_per_invocation

Responses

201

A2A channel created. The api_key field is the plaintext key returned exactly once and never recoverable later.

Output of [AddA2aChannelCmd] — includes the plaintext API key (returned once, never persisted) plus the resulting [AppChannel].

object

api_key

required

Plaintext API key. Persist this — it cannot be recovered later.

string

channel

required

The created A2A channel.

object

channel_config

Channel-specific configuration (validated per channel type).

channel_type

required

Channel type (e.g. slack).

string

Allowed values: slack ag_ui schedule webhook a2a

created_at

required

Timestamp when this channel was created.

string format: date-time

enabled

Whether this channel is enabled.

boolean

id

required

External identifier (appchan_<32-hex>). Shown as “id” in API.

string

Example

appchan_01933b5a000070008000000000000001

updated_at

required

Timestamp when this channel was last updated.

string format: date-time

400

Validation error

Standard error response for API endpoints.

object

error

required

Error message describing what went wrong.

string

401

Unauthorized

Standard error response for API endpoints.

object

error

required

Error message describing what went wrong.

string

403

Forbidden

Standard error response for API endpoints.

object

error

required

Error message describing what went wrong.

string

404

App not found

Standard error response for API endpoints.

object

error

required

Error message describing what went wrong.

string