Get the AI agent configuration for a site

Retrieves the configuration for the AI built into the GitBook editor that assists authors with drafting and refining content changes. Use this before updating agent settings to understand the current configuration.

Available in MCP

get

Authorizations

useroauth

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

Responses

200

OK

application/json

objectstring · enumRequiredPossible values:

updatedAtstring · date-timeOptional

updatedBystringOptional

Identifier of the member who last updated the settings.

400

Bad Request

application/json

get/orgs/{organizationId}/sites/{siteId}/agent-settings

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/agent-settings HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "object": "site-agent-settings",
  "updatedAt": "2026-07-21T22:59:02.535Z",
  "updatedBy": "text",
  "urls": {
    "location": "text"
  },
  "scans": {
    "topics": "auto"
  },
  "findings": {
    "changeRequests": "always"
  },
  "editing": {
    "customInstructions": {
      "object": "document",
      "data": {},
      "nodes": [
        {
          "object": "block",
          "type": "paragraph",
          "data": {},
          "nodes": [
            {
              "object": "text",
              "leaves": [
                {
                  "object": "leaf",
                  "text": "Hello world",
                  "marks": []
                }
              ]
            }
          ]
        }
      ]
    }
  }
}