hosting

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

Switch on the chat agent for this site.

Упълномощаване

Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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[]`	Да	—

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422

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