Skip to main content
GET
/
public-api
/
channels
/
{channel_id}
Get a channel
curl --request GET \
  --url https://api.neoagent.io/public-api/channels/{channel_id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "agent_id": 123,
    "color_icon_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "display_name": "<string>",
    "id": "<string>",
    "internal_name": "<string>",
    "outline_icon_url": "<string>",
    "relay_prefix": "<string>",
    "show_agent_progress_steps": true,
    "updated_at": "2023-11-07T05:31:56Z",
    "welcome_message": "<string>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timings_ms": {},
    "pagination": {
      "has_more": true,
      "next_cursor": "<string>"
    },
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

Authorization
string
header
required

Authorization: Bearer <token> where <token> is either a neo_sk_<env>_<secret> API key (service account) or a Microsoft Entra ID access token (dashboard user).

Path Parameters

channel_id
string
required

Response

Success.

data
PublicChannel · object
required

A channel: a CONVERSATIONAL agent bound to a transport, plus its branding.

meta
object
required