---
title: "Create Channel Connection"
method: POST
path: "/channels/connections/"
tags: ["Channels"]
---

# Create Channel Connection

`POST /channels/connections/`

## Request body

- ChannelConnectionRequest
  - `connection` ChannelConnectionCreate, required
    - `flags` ChannelConnectionFlags
      - `is_active` boolean
      - `is_verified` boolean
      - `is_hosted` boolean
    - `tags` object, nullable
    - `meta` object, nullable
    - `name` string, nullable
    - `description` string, nullable
    - `slug` string, nullable
    - `channel` string, required
    - `external_key` string, uuid, nullable
    - `data` object, nullable
    - `credentials` object, nullable

## Response `200`

Successful Response

- ChannelConnectionResponse
  - `count` integer
  - `connection` ChannelConnection
    - `flags` ChannelConnectionFlags
      - `is_active` boolean
      - `is_verified` boolean
      - `is_hosted` boolean
    - `tags` object, nullable
    - `meta` object, nullable
    - `name` string, nullable
    - `description` string, nullable
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `deleted_at` string, date-time, nullable
    - `created_by_id` string, uuid, nullable
    - `updated_by_id` string, uuid, nullable
    - `deleted_by_id` string, uuid, nullable
    - `slug` string, nullable
    - `id` string, uuid, nullable
    - `channel` string, required
    - `external_key` string, uuid, required
    - `data` object, nullable
    - `status` Status
      - `timestamp` string, date-time
      - `type` string, nullable
      - `code` string, nullable
      - `message` string, nullable
      - `stacktrace` string, nullable
  - `setup` ChannelSetup
    - `instructions` string[]
    - `document` ChannelSetupDoc — What `build_setup_document` generates, request-url-dependent and so never baked into the static capability declaration.
      - `format` string, required
      - `content` string, required
      - `filename` string, nullable
      - `link` string, nullable
    - `fields` ChannelSetupField[]
      - `name` string, required
      - `label` string, required
      - `secret` boolean
      - `required` boolean
      - `help` string, nullable
      - `pattern` string, nullable
      - `pattern_error` string, nullable
    - `hosted_available` boolean

## Other responses

- `422` — Validation Error

## Changes

- **2026-09-24** `a28f1d059149` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/agenta-ai/apis/agenta-api/changes/channels/connections/post.md)

---

[API](https://skmtc.dev/agenta-ai/apis/agenta-api.md) · [All operations](https://skmtc.dev/agenta-ai/apis/agenta-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agenta-ai/apis/agenta-api/revisions/72f2feba8ccb?raw)