hosting
GET /v1/sites/{siteId}/chat-agent
The AI chat agent on this site — how it is configured and what it knows.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/chat-agent \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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