hosting

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

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

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Энэхүү төгсгөлийн цэг нь тодорхойлолтдоо тодорхой зөвшөөрлийг заагаагүй тул түлхүүрээрээ шаардагдах хамгийн бага эрхийг өгч, таамаглахаас илүүтэйгээр хариуг шалгана уу.

Энэ төгсгөл цэг нь ямар ч байгууллагын 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