hosting

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

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

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 PATCH 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

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.

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

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