hosting

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

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

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

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

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

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

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

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

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

Мәліметтер

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.

Параметрлер

Аты	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

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