channels.createChannel

POST

/v1/organization/channels

curl --request POST \
  --url https://example.com/v1/organization/channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "agent": "example", "credentials": { "kind": "slack", "botToken": "example", "signingSecret": "example" }, "linkPath": "example", "enabled": true }'

Creates a Channel. The caller becomes its actor. For Telegram, OpenBot also sets the webhook of the bot.

Authorizations

• token
• session

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 120 characters

agent

required

string

>= 1 characters <= 128 characters

credentials

required

Any of:

object

object

kind

required

string

Allowed values: slack

botToken

required

string

>= 1 characters <= 4096 characters

signingSecret

required

string

>= 1 characters <= 4096 characters

object

object

kind

required

string

Allowed values: lark

domain

required

string

Allowed values: feishu lark

appId

required

string

>= 1 characters <= 200 characters

appSecret

required

string

>= 1 characters <= 4096 characters

verificationToken

required

string

>= 1 characters <= 4096 characters

encryptKey

required

string

>= 1 characters <= 4096 characters

object

object

kind

required

string

Allowed values: telegram

botToken

required

string

>= 1 characters <= 4096 characters

object

object

kind

required

string

Allowed values: custom

endpoint

required

string

>= 1 characters <= 2048 characters

linkPath

string

<= 4096 characters

enabled

boolean

Responses

201

Success

Media typeapplication/json

object

id

required

string

>= 1 characters <= 128 characters

kind

required

string

Allowed values: slack lark telegram custom

name

required

string

agent

required

string

>= 1 characters <= 128 characters

actor

required

string

enabled

required

boolean

linkPath

required

Any of:

string

string

null

null

webhookUrl

required

string

credentials

required

Any of:

object

object

kind

required

string

Allowed values: slack

botToken

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

signingSecret

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

object

object

kind

required

string

Allowed values: lark

domain

required

string

Allowed values: feishu lark

appId

required

string

appSecret

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

verificationToken

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

encryptKey

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

object

object

kind

required

string

Allowed values: telegram

botToken

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

object

object

kind

required

string

Allowed values: custom

endpoint

required

string

secret

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

version

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

Example

{
  "kind": "slack",
  "credentials": {
    "kind": "slack"
  }
}

400

ChannelInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ChannelInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "ChannelInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write

resource

required

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

ChannelNotFound | ChannelIdentityNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ChannelNotFound

id

required

string

object

object

_tag

required

string

Allowed values: ChannelIdentityNotFound

Example

{
  "_tag": "ChannelNotFound"
}

409

ChannelConflict

Media typeapplication/json

object

_tag

required

string

Allowed values: ChannelConflict

version

required

integer

<= 9007199254740991

Example

{
  "_tag": "ChannelConflict"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

AuthorizationUnavailable | ChannelsUnavailable | AuthenticationUnavailable

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: AuthorizationUnavailable

object

object

_tag

required

string

Allowed values: ChannelsUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

Example

{
  "_tag": "AuthorizationUnavailable"
}