public

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

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

Аутентификација

Ова крајња тачка је јавна. Не захтева никакве акредитиве нити организацију — то је оно што читају наш сопствени маркетиншки сајт и машине за одговоре са вештачком интелигенцијом.

Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

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

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у 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,…

Грешке које ова крајња тачка може вратити

404 · 429

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