hosting

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

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

Նույնականացում

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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.

Պարամետրեր

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`siteId (path)`	`Uuid`	Այո	Site ID (UUIDv7).

Հարցման մարմին

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`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`	Ոչ	—

Պատասխան

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`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