Update the AI agent configuration for a site

Replaces the configuration for the AI built into the GitBook editor that helps authors draft, review, and refine content changes. Use this to customize how the AI behaves when assisting authors working on content for this site.

Available in MCP

put

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

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

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

PUT /v1/orgs/{organizationId}/sites/{siteId}/agent-settings HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "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": []
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

{
  "object": "site-agent-settings",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "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": []
                }
              ]
            }
          ]
        }
      ]
    }
  }
}