For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create a new GitBook Agent channel for a site

Configures a new channel integration that allows GitBook Agent to operate within an external tool connected to this site. The channel role determines whether the Agent acts as a support assistant — answering questions sourced from the site's documentation — or as a collaborator that can open change requests and sync documentation updates directly from the connected platform.

Available in MCP
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
siteIdstringRequired

The unique id of the site

Body
anyOptional
or
or
or
and
Responses
201

Site channel created

application/json
anyOptional
or
or
or
and
post/orgs/{organizationId}/sites/{siteId}/channels
POST /v1/orgs/{organizationId}/sites/{siteId}/channels HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "type": "builtin:slack",
  "setupSettings": {
    "allowedChannels": [
      "text"
    ]
  },
  "role": "collaborator"
}
201

Site channel created

{
  "type": "builtin:slack",
  "setupSettings": {
    "allowedChannels": [
      "text"
    ]
  },
  "object": "site-channel",
  "id": "text",
  "status": "active",
  "role": "collaborator",
  "answers": 1,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "urls": {
    "location": "https://example.com"
  }
}

Last updated

Was this helpful?

Powered by GitBook