hosting

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

Switch on the chat agent for this site.

Doğrulama

API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.

Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/chat-agent \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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.

Parametrlər

Ad	Tip	Tələb olunur	Nədir
`siteId (path)`	`Uuid`	Bəli	Site ID (UUIDv7).

Sorğu gövdəsi

Ad	Tip	Tələb olunur	Nədir
`name`	`string`	Xeyr	—
`greeting`	`string`	Xeyr	—
`persona`	`string`	Xeyr	—
`brand_colour`	`string`	Xeyr	—
`launcher_position`	`string<left, right>`	Xeyr	—
`handoff_enabled`	`boolean`	Xeyr	—
`status`	`string<active, paused>`	Xeyr	—
`allowed_origins`	`string[]`	Xeyr	—
`monthly_message_cap`	`integer`	Xeyr	—

Cavab

Ad	Tip	Tələb olunur	Nədir
`id`	`string`	Bəli	—
`site_id`	`string`	Xeyr	—
`name`	`string`	Bəli	What the agent calls itself to visitors. The customer's brand, not ours.
`greeting`	`string`	Xeyr	—
`persona`	`string`	Xeyr	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`	Xeyr	—
`launcher_position`	`string<left, right>`	Xeyr	—
`status`	`string<active, paused>`	Bəli	`paused` stops it answering and keeps everything it has learned, so switching back on is instant rather than a re-index.
`handoff_enabled`	`boolean`	Xeyr	Offer to pass the visitor to a person when the agent cannot answer.
`public_key`	`string`	Bəli	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[]`	Bəli	Origins the public endpoints will answer for. ⛔ Empty refuses everything — it means "not installed yet", never "allow anything".
`monthly_message_cap`	`integer`	Xeyr	Messages included per calendar month. Checked before each answer.
`messages_this_month`	`integer`	Xeyr	—
`indexed_chunks`	`integer`	Xeyr	Passages of the site currently searchable. Zero means it knows nothing yet.
`embed_snippet`	`string`	Xeyr	The two lines to paste into any website.
`sources`	`ChatAgentSource[]`	Bəli	—

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 422

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