hosting
GET /v1/sites/{siteId}/chat-agent
The AI chat agent on this site — how it is configured and what it knows.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/chat-agent \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
The agent's name, personality, colours, the domains it may be embedded on, what it has read, how many messages it has answered this month, and the snippet to paste into a site we do not host. 404 when this site has no agent. Buying ai_chat_agent from the add-on store creates one; so does POST to this path once the product is owned.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
siteId (path) | Uuid | Так | Site ID (UUIDv7). |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
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