hosting

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

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

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

Název	Typ	Požadováno	Co to je
`siteId (path)`	`Uuid`	Ano	Site ID (UUIDv7).

Tělo požadavku

Název	Typ	Požadováno	Co to je
`name`	`string`	Ne	—
`greeting`	`string`	Ne	—
`persona`	`string`	Ne	—
`brand_colour`	`string`	Ne	—
`launcher_position`	`string<left, right>`	Ne	—
`handoff_enabled`	`boolean`	Ne	—
`status`	`string<active, paused>`	Ne	—
`allowed_origins`	`string[]`	Ne	—
`monthly_message_cap`	`integer`	Ne	—

Odpověď

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

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422

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