Site agent settings

Configure site-specific issue remediation behavior and agent instructions.

Configure how site issue remediation should behave and provide site-specific instructions for the editing and topic analyst agents.

The SiteAgentSettings object

Attributes

objectstring · enumRequiredPossible values:

updatedAtstring · date-timeOptional

updatedBystringOptional

Identifier of the member who last updated the settings.

The SiteAgentSettings object

{
  "object": "site-agent-settings",
  "updatedAt": "2026-04-04T19:59:55.918Z",
  "updatedBy": "text",
  "urls": {
    "location": "text"
  },
  "scans": {
    "topics": "auto"
  },
  "findings": {
    "changeRequests": "always"
  },
  "editing": {
    "customInstructions": {
      "object": "document",
      "data": {
        "schemaVersion": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "nodes": [
        "[Circular Reference]"
      ],
      "meta": {
        "token": "text"
      }
    }
  }
}

Get site agent settings

get

Authorizations

user

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-04-04T19:59:55.918Z",
  "updatedBy": "text",
  "urls": {
    "location": "text"
  },
  "scans": {
    "topics": "auto"
  },
  "findings": {
    "changeRequests": "always"
  },
  "editing": {
    "customInstructions": {
      "object": "document",
      "data": {
        "schemaVersion": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "nodes": [
        "[Circular Reference]"
      ],
      "meta": {
        "token": "text"
      }
    }
  }
}

Update site agent settings

put

Authorizations

user

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

application/json

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

HTTPcURLJavaScriptPython

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: 341

{
  "scans": {
    "topics": "auto"
  },
  "findings": {
    "changeRequests": "always"
  },
  "editing": {
    "customInstructions": {
      "object": "document",
      "data": {
        "schemaVersion": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "nodes": [
        {
          "object": "block",
          "type": "paragraph",
          "key": "text",
          "nodes": "[Circular Reference]",
          "isVoid": false,
          "data": {
            "align": "start"
          }
        }
      ],
      "meta": {
        "token": "text"
      }
    }
  }
}

{
  "object": "site-agent-settings",
  "updatedAt": "2026-04-04T19:59:55.918Z",
  "updatedBy": "text",
  "urls": {
    "location": "text"
  },
  "scans": {
    "topics": "auto"
  },
  "findings": {
    "changeRequests": "always"
  },
  "editing": {
    "customInstructions": {
      "object": "document",
      "data": {
        "schemaVersion": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "nodes": [
        "[Circular Reference]"
      ],
      "meta": {
        "token": "text"
      }
    }
  }
}