hosting
GET /v1/sites/{siteId}/chat-agent
The AI chat agent on this site — how it is configured and what it knows.
Kimlik Doğrulama
Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/chat-agent \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
siteId (path) | Uuid | Evet | Site ID (UUIDv7). |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | string | Evet | — |
site_id | string | Hayır | — |
name | string | Evet | What the agent calls itself to visitors. The customer's brand, not ours. |
greeting | string | Hayır | — |
persona | string | Hayır | 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 | Hayır | — |
launcher_position | string<left, right> | Hayır | — |
status | string<active, paused> | Evet | paused stops it answering and keeps everything it has learned, so switching back on is instant rather than a re-index. |
handoff_enabled | boolean | Hayır | Offer to pass the visitor to a person when the agent cannot answer. |
public_key | string | Evet | 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[] | Evet | Origins the public endpoints will answer for. ⛔ Empty refuses everything — it means "not installed yet", never "allow anything". |
monthly_message_cap | integer | Hayır | Messages included per calendar month. Checked before each answer. |
messages_this_month | integer | Hayır | — |
indexed_chunks | integer | Hayır | Passages of the site currently searchable. Zero means it knows nothing yet. |
embed_snippet | string | Hayır | The two lines to paste into any website. |
sources | ChatAgentSource[] | Evet | — |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404