hosting

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

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

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 PATCH https://api.zinndigital.com/v1/sites/{siteId}/chat-agent \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

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.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`siteId (path)`	`Uuid`	Evet	Site ID (UUIDv7).

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`name`	`string`	Hayır	—
`greeting`	`string`	Hayır	—
`persona`	`string`	Hayır	—
`brand_colour`	`string`	Hayır	—
`launcher_position`	`string<left, right>`	Hayır	—
`handoff_enabled`	`boolean`	Hayır	—
`status`	`string<active, paused>`	Hayır	—
`allowed_origins`	`string[]`	Hayır	—
`monthly_message_cap`	`integer`	Hayır	—

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 · 422

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