hosting

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

Switch on the chat agent for this site.

Tất cả tài liệu dành cho nhà phát triển →

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.

Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

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

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

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.

Tham số

Tên	Loại	Bắt buộc	Nội dung này là gì
`siteId (path)`	`Uuid`	Có	Site ID (UUIDv7).

Nội dung yêu cầu

Tên	Loại	Bắt buộc	Nội dung này là gì
`name`	`string`	Không	—
`greeting`	`string`	Không	—
`persona`	`string`	Không	—
`brand_colour`	`string`	Không	—
`launcher_position`	`string<left, right>`	Không	—
`handoff_enabled`	`boolean`	Không	—
`status`	`string<active, paused>`	Không	—
`allowed_origins`	`string[]`	Không	—
`monthly_message_cap`	`integer`	Không	—

Phản hồi

Tên	Loại	Bắt buộc	Nội dung này là gì
`id`	`string`	Có	—
`site_id`	`string`	Không	—
`name`	`string`	Có	What the agent calls itself to visitors. The customer's brand, not ours.
`greeting`	`string`	Không	—
`persona`	`string`	Không	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`	Không	—
`launcher_position`	`string<left, right>`	Không	—
`status`	`string<active, paused>`	Có	`paused` stops it answering and keeps everything it has learned, so switching back on is instant rather than a re-index.
`handoff_enabled`	`boolean`	Không	Offer to pass the visitor to a person when the agent cannot answer.
`public_key`	`string`	Có	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[]`	Có	Origins the public endpoints will answer for. ⛔ Empty refuses everything — it means "not installed yet", never "allow anything".
`monthly_message_cap`	`integer`	Không	Messages included per calendar month. Checked before each answer.
`messages_this_month`	`integer`	Không	—
`indexed_chunks`	`integer`	Không	Passages of the site currently searchable. Zero means it knows nothing yet.
`embed_snippet`	`string`	Không	The two lines to paste into any website.
`sources`	`ChatAgentSource[]`	Có	—

Các lỗi điểm cuối này có thể trả về

401 · 403 · 404 · 422

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