hosting

PATCH `/v1/sites/{siteId}/chat-agent`

Change the agent's name, personality, brand or the domains it may appear on.

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

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

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

Попробовать

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

curl -X PATCH https://api.zinndigital.com/v1/sites/{siteId}/chat-agent \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Подробнее

Everything a visitor sees is here — and it is the customer's brand, not ours. ⛔ allowed_origins is a fence, not a preference. The public endpoints answer only for an origin on this list, and an empty list refuses everything: it means "not installed anywhere yet", never "allow anything". Entries are normalised to scheme://host, so pasting a full page address works. monthly_message_cap is checked before each answer, not reconciled afterwards, so it is a real limit on what this agent can spend rather than a report on what it did.

Параметры

Имя	Тип	Обязательно	Что это
`siteId (path)`	`Uuid`	Да	Site ID (UUIDv7).

Тело запроса

Имя	Тип	Обязательно	Что это
`name`	`string`	Нет	—
`greeting`	`string`	Нет	—
`persona`	`string`	Нет	—
`brand_colour`	`string`	Нет	—
`launcher_position`	`string<left, right>`	Нет	—
`handoff_enabled`	`boolean`	Нет	—
`status`	`string<active, paused>`	Нет	—
`allowed_origins`	`string[]`	Нет	—
`monthly_message_cap`	`integer`	Нет	—

Ответ

Имя	Тип	Обязательно	Что это
`id`	`string`	Да	—
`site_id`	`string`	Нет	—
`name`	`string`	Да	What the agent calls itself to visitors. The customer's brand, not ours.
`greeting`	`string`	Нет	—
`persona`	`string`	Нет	Free text describing tone and what to say. ⛔ It cannot widen what the agent may read — retrieval decides that before the model sees anything.
`brand_colour`	`string`	Нет	—
`launcher_position`	`string<left, right>`	Нет	—
`status`	`string<active, paused>`	Да	`paused` stops it answering and keeps everything it has learned, so switching back on is instant rather than a re-index.
`handoff_enabled`	`boolean`	Нет	Offer to pass the visitor to a person when the agent cannot answer.
`public_key`	`string`	Да	Carried in the embed snippet. It identifies the agent and authorises nothing a page's reader could not already do — the fence is `allowed_origins`.
`allowed_origins`	`string[]`	Да	Origins the public endpoints will answer for. ⛔ Empty refuses everything — it means "not installed yet", never "allow anything".
`monthly_message_cap`	`integer`	Нет	Messages included per calendar month. Checked before each answer.
`messages_this_month`	`integer`	Нет	—
`indexed_chunks`	`integer`	Нет	Passages of the site currently searchable. Zero means it knows nothing yet.
`embed_snippet`	`string`	Нет	The two lines to paste into any website.
`sources`	`ChatAgentSource[]`	Да	—

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

401 · 403 · 404 · 422

PATCH /v1/sites/{siteId}/chat-agent