hosting

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

Switch on the chat agent for this site.

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 POST 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

Creates the agent, named after the site and pre-authorised for the site's own domains so the snippet works the moment it is pasted. ⛔ Refuses with 422 when the product has not been bought for this site, or when the account is not in good standing — two different refusals with two different remedies, told apart by the code in the error details (not_purchased / not_in_good_standing). A suspension is not cleared by credit, so that refusal deliberately offers no top-up. Calling it twice returns the existing agent with 200 rather than an error.

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

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