hosting

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

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

Toute la documentation pour développeurs →

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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.

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`siteId (path)`	`Uuid`	Oui	Site ID (UUIDv7).

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`name`	`string`	Non	—
`greeting`	`string`	Non	—
`persona`	`string`	Non	—
`brand_colour`	`string`	Non	—
`launcher_position`	`string<left, right>`	Non	—
`handoff_enabled`	`boolean`	Non	—
`status`	`string<active, paused>`	Non	—
`allowed_origins`	`string[]`	Non	—
`monthly_message_cap`	`integer`	Non	—

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`id`	`string`	Oui	—
`site_id`	`string`	Non	—
`name`	`string`	Oui	What the agent calls itself to visitors. The customer's brand, not ours.
`greeting`	`string`	Non	—
`persona`	`string`	Non	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`	Non	—
`launcher_position`	`string<left, right>`	Non	—
`status`	`string<active, paused>`	Oui	`paused` stops it answering and keeps everything it has learned, so switching back on is instant rather than a re-index.
`handoff_enabled`	`boolean`	Non	Offer to pass the visitor to a person when the agent cannot answer.
`public_key`	`string`	Oui	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[]`	Oui	Origins the public endpoints will answer for. ⛔ Empty refuses everything — it means "not installed yet", never "allow anything".
`monthly_message_cap`	`integer`	Non	Messages included per calendar month. Checked before each answer.
`messages_this_month`	`integer`	Non	—
`indexed_chunks`	`integer`	Non	Passages of the site currently searchable. Zero means it knows nothing yet.
`embed_snippet`	`string`	Non	The two lines to paste into any website.
`sources`	`ChatAgentSource[]`	Oui	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422

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