public

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

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

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

Бұл соңғы нүкте жалпыға қолжетімді. Ол ешқандай тіркелгі деректерін және ешқандай ұйымды қажет етпейді — оны біздің өзіміздің маркетингтік сайтымыз бен жасанды интеллект жауап беретін жүйелеріміз оқиды.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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

Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған 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.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`publicKey (path)`	`string`	Иә	The agent's public key, as carried in the embed snippet.

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`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`	Жоқ	—

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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