hosting

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

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

Санҷиши ҳаққоният

Kalitи API-ро ҳамчун token-и bearer фиристед. Ин нуқтаи ниҳоӣ дар мушаххасот иҷозати мушаххасеро нишон намедиҳад, бинобар ин ба калиди худ ҳадди ақали заруриро диҳед ва ба ҷои тахмин кардан, ҷавобро санҷед.

Ин нуқтаи поёнӣ ягон рақами мушаххаси созмонро талаб намекунад. Калиди шумо аллакай созмонеро, ки ба он тааллуқ дорад, муайян мекунад ва ҷавоб ба он маҳдуд карда мешавад.

Санҷидан

Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.

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

Воarid шудаед? Консоли 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.

Параметрҳо

Ном	Намуд	Талаб карда мешавад	Ин чӣ аст
`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