hosting
PATCH /v1/sites/{siteId}/chat-agent
Change the agent's name, personality, brand or the domains it may appear on.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織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