hosting

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

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

所有 hosting 端点

所有开发者文档 →

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。

此端点不需要组织 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