Channels

List a channel's routes

One channel's routes, newest first, disabled ones included — only active routes take part in resolution. For every route in the project in one read, use GET /v1/projects/{project_id}/channel-routes.

get/v1/projects/{project_id}/channels/{channel_id}/routes

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/channels/{channel_id}/routes
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Query parameters

limitinteger

Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an integer it is 400.

cursorstring

Opaque pagination cursor from a previous response's next_cursor.

Response

A page of routes.

next_cursorstring nullable required

Example response

{
  "data": [
    {
      "action": "agent",
      "agent_id": "agent_V1StGXR8Z5jdHi6B",
      "text": "Subscribe at https://example.com/pricing",
      "language": "en-US",
      "config": {
        "media": {
          "audio": "transcribe"
        },
        "discord": {
          "allowed_role_ids": [
            "1290000000000000042"
          ]
        }
      },
      "id": "route_V1StGXR8Z5jdHi6B",
      "project_id": "proj_V1StGXR8Z5jdHi6B",
      "channel_id": "chan_V1StGXR8Z5jdHi6B",
      "surface": "guild_thread",
      "match": {
        "guild_id": "9988776655"
      },
      "status": "active"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.