hosting

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

Switch on the chat agent for this site.

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

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

Энэ төгсгөл цэг нь ямар ч байгууллагын ID шаардахгүй. Таны түлхүүр аль хэдийн харьяалагдах байгууллагыг тодорхойлж байгаа бөгөөд хариу нь тухайн байгууллагын хүрээнд хязгаарлагдана.

Туршиж үзэх

Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.

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

Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй 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.

Параметрүүд

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`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

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