public

POST `/v1/public/chat-agents/{publicKey}/messages`

One visitor turn — a question, and the answer from that site's own pages.

Упълномощаване

Този крайpoint е публичен. Той не изисква данни за удостоверяване и организация — това е съдържанието, което нашият собствен маркетинг сайт и AI машини за отговори четат.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

curl -X POST https://api.zinndigital.com/v1/public/chat-agents/{publicKey}/messages \
  -H "Content-Type: application/json" \
  -d '{ "message": <string> }'

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

The agent answers only from content belonging to this one site. That is enforced in the database query, not by instructing the model, so there is no phrasing a visitor can use to reach another customer's content. handoff_suggested is its own field and is not an error. It is true when the agent could not find the answer on the site — nothing is broken, those pages simply do not say — and the right response is to offer a person, never a guess. refusal is present only when the turn was refused rather than answered, and names the class so a widget can render the right thing: provider_outage, credential_problem, refused (a deliberate decline, such as a monthly cap reached) or unavailable (our fault, and no vendor is named). Answers 404 for an unauthorised Origin, exactly as the config route does and for the same reason.

Параметри

Име	Тип	Задължително	Какво представлява
`publicKey (path)`	`string`	Да	The agent's public key, as carried in the embed snippet.

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`message`	`string`	Да	—
`conversation_id`	`string`	Не	Continue an existing thread. Omit to start one.
`locale`	`string`	Не	The visitor's language. The agent answers in this, not in the site owner's language.
`page_url`	`string`	Не	—

Отговор

Име	Тип	Задължително	Какво представлява
`conversation_id`	`string`	Да	—
`reply`	`string`	Да	—
`citations`	`object[]`	Да	The pages of this site the answer was drawn from.
`handoff_suggested`	`boolean`	Да	⛔ Not an error. `true` means the agent could not answer from this site's content and a person should take over. Rendering it as a fault would blame a vendor outage for an…
`refusal`	`string<provider_outage, credential_problem, refused, unavailable>`	Не	Present only when the turn was refused rather than answered. `refused` is a deliberate decline of ours (a monthly cap reached, an agent switched off) and names no vendor;…
`failure`	`VendorFailure`	Не	The classified §2.57 failure behind a refusal — which vendor, whose key, which door. ⛔ Returned ONLY by the owner's preview endpoint; the public widget endpoint never carries it,…

Грешки, които този крайpoint може да върне

404 · 429

POST /v1/public/chat-agents/{publicKey}/messages