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