public

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

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

Gbogbo àwọn public endpoints

Gbogbo àwọn ìwé àṣẹ olùgbékalẹ̀ àgbékalẹ̀

Ìfàṣẹ́pọ̀

Ojú-wọ̀n yìí jẹ́ ti gbogbo ènìyàn. Kò gba àmì ìdánimọ̀ kankan tàbí àgbájọ kankan — ohun tí ojú-wọ̀n ìpolówó wa àti àwọn ẹ̀rọ ìdáhùn AI ǹkà kọ́ ni.

Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

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

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

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.

Àwọn ìpìlẹ̀

OrúkọIruTí a nílòKini o jẹ
publicKey (path)stringBẹẹniThe agent's public key, as carried in the embed snippet.

Akoonu ibeere naa

OrúkọIruTí a nílòKini o jẹ
messagestringBẹẹni
conversation_idstringBẹẹkọContinue an existing thread. Omit to start one.
localestringBẹẹkọThe visitor's language. The agent answers in this, not in the site owner's language.
page_urlstringBẹẹkọ

Idahun

OrúkọIruTí a nílòKini o jẹ
conversation_idstringBẹẹni
replystringBẹẹni
citationsobject[]BẹẹniThe pages of this site the answer was drawn from.
handoff_suggestedbooleanBẹẹniNot 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…
refusalstring<provider_outage, credential_problem, refused, unavailable>Bẹẹkọ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;…
failureVendorFailureBẹẹkọ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,…

Awọn aṣiṣe ti ibudo ipari yii le da pada

404 · 429