PUT `/v1/ai/site-agent/preferences`

Choose what the AI may do for one kind of fix.

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.view; ключ без него отклоняется с кодом 403, а не 404.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X PUT https://api.zinndigital.com/v1/ai/site-agent/preferences \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "action": <string>, "mode": <AiSiteAgentMode> }'

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

Records the customer's wish. The **requested** value is stored, never the clamped one: a customer who asks for "just fix it" on a fix still earning its rung keeps that setting, and it takes effect on its own the day the fix is promoted. Storing the clamp instead would quietly downgrade them for ever with no way to see it had happened. An unknown action or remedy key is a `422` naming it, never a silently ignored write. Requires `sites.view`.

Тело запроса

Имя	Тип	Обязательно	Что это
`action`	`string`	Да	—
`mode`	`AiSiteAgentMode`	Да	What the customer wants the AI to do about one kind of fix. `ask` proposes it and waits for a button; `canary` applies it to one site and checks the result; `auto` applies it an…

Ответ

Имя	Тип	Обязательно	Что это
`action`	`string`	Да	The fix this row is about — an agent action key or a support remedy key.
`requested`	`AiSiteAgentMode`	Да	What the customer chose, stored as they chose it.
`effective`	`AiSiteAgentMode`	Да	What will actually happen — `requested` clamped to `ceiling`.
`ceiling`	`AiSiteAgentMode`	Да	The highest mode the PLATFORM currently permits for this fix. The customer cannot raise it; it moves when the fix earns a higher rung.
`clamped`	`boolean`	Да	True when the customer asked for more than the ceiling allows. The screen must say so — otherwise their choice looks as though it did not register.
`reason`	`string`	Нет	Why the ceiling is where it is, in words a customer reads.

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 422 · 429

PUT /v1/ai/site-agent/preferences