Skip to main content
POST
Create Channel

Headers

x-user-id
string
required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Body

application/json

Request body for creating a channel.

channel_type
string
required

Channel type id, e.g. 'feishu'.

credentials
Credentials · object
required

Platform credentials.

routing
RoutingConfig · object
required

Inbound routing rules.

session
SessionSettings · object
required

Session/model settings.

name
string | null

Optional display name.

platform_config
Platform Config · object

Non-secret platform options.

enabled
boolean
default:true

Start it enabled.

Response

Successful Response

Channel details returned to the client (credentials omitted).

id
string
required
channel_type
string
required
name
string | null
required
user_id
string
required
platform_bot_id
string
required
enabled
boolean
required
platform_config
Platform Config · object
required
routing
RoutingConfig · object
required

Ordered routing rules for a channel.

Validated so routing is always total and unambiguous: exactly one catch-all, placed last, with no duplicate (match_key, match_value) pairs.

session
SessionSettings · object
required

Settings applied when a channel creates an agent session.

created_at
string
required
updated_at
string
required