hosting

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

Switch on the chat agent for this site.

Wszystkie dokumentacje dla programistów →

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

Creates the agent, named after the site and pre-authorised for the site's own domains so the snippet works the moment it is pasted. ⛔ Refuses with 422 when the product has not been bought for this site, or when the account is not in good standing — two different refusals with two different remedies, told apart by the code in the error details (not_purchased / not_in_good_standing). A suspension is not cleared by credit, so that refusal deliberately offers no top-up. Calling it twice returns the existing agent with 200 rather than an error.

Parametry

Nazwa	Typ	Wymagane	Co to jest
`siteId (path)`	`Uuid`	Tak	Site ID (UUIDv7).

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`name`	`string`	Nie	—
`greeting`	`string`	Nie	—
`persona`	`string`	Nie	—
`brand_colour`	`string`	Nie	—
`launcher_position`	`string<left, right>`	Nie	—
`handoff_enabled`	`boolean`	Nie	—
`status`	`string<active, paused>`	Nie	—
`allowed_origins`	`string[]`	Nie	—
`monthly_message_cap`	`integer`	Nie	—

Odpowiedź

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

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422

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