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