hosting

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

Switch on the chat agent for this site.

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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

Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз

Мәліметтер

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.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`siteId (path)`	`Uuid`	Иә	Site ID (UUIDv7).

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`name`	`string`	Жоқ	—
`greeting`	`string`	Жоқ	—
`persona`	`string`	Жоқ	—
`brand_colour`	`string`	Жоқ	—
`launcher_position`	`string<left, right>`	Жоқ	—
`handoff_enabled`	`boolean`	Жоқ	—
`status`	`string<active, paused>`	Жоқ	—
`allowed_origins`	`string[]`	Жоқ	—
`monthly_message_cap`	`integer`	Жоқ	—

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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 · 422

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