Create a new channel

import requests
url = "https://example.ada.support/api/v2/channels/"
payload = {
    "description": "A custom messaging channel for my AI Agent",
    "modality": "messaging",
    "name": "My Custom Channel"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "description": "A custom messaging channel for my AI Agent",
  "modality": "messaging",
  "name": "My Custom Channel",
  "capabilities": {
    "markdown": true
  },
  "created_at": "2020-09-20T00:00:00+00:00",
  "id": "5df263b7db5a7e6ea03fae9b",
  "metadata": {
    "example_key1": "example_string_value",
    "example_key2": true,
    "example_key3": 123,
    "example_key4": 0.95
  },
  "type": "custom"
}

Create a new channel. A maximum of 100 channels can be created per account per day. The maximum request size is 10MB.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

descriptionstringRequired

A description of the channel

modalityenumRequired

The modality of the channel

namestringRequired

The name of the channel

capabilitiesobjectOptional

What the channel’s surface can render. The AI Agent tailors replies to the declared capabilities. Omitted fields default to false. Read-only on native channels, whose capabilities are fixed by the surface.

metadatamap from strings to strings or booleans or integers or doublesOptional

A dictionary of key, value pairs assigned to the channel. Metadata may not exceed 4KB total.

metadata keys may only be of type: string
metadata values may only be one of type: string, boolean, integer, or number (float)

Response

Channel created

descriptionstring

A description of the channel

modalityenum

The modality of the channel

namestring

The name of the channel

capabilitiesobjectOptional

created_atstringOptionalRead-onlyformat: "date-time"

The date and time the channel was created

idstringOptionalRead-onlyformat: "id"

The channel ID

metadatamap from strings to strings or booleans or integers or doublesOptional

A dictionary of key, value pairs assigned to the channel. Metadata may not exceed 4KB total.

metadata keys may only be of type: string
metadata values may only be one of type: string, boolean, integer, or number (float)

typeenumOptionalRead-only

The type of the channel

Errors

400

Bad Request Error

401

Unauthorized Error

413

Content Too Large Error

429

Too Many Requests Error

500

Internal Server Error