public

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

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

Hitelesítés

Ez a végpont nyilvános. Nem igényel hitelesítő adatot és szervezetet sem – ezt olvassa a saját marketingoldalunk és az MI-válaszadó motorunk is.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

Név	Típus	Kötelező	Mi ez
`publicKey (path)`	`string`	Igen	The agent's public key, as carried in the embed snippet.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`message`	`string`	Igen	—
`conversation_id`	`string`	Nem	Continue an existing thread. Omit to start one.
`locale`	`string`	Nem	The visitor's language. The agent answers in this, not in the site owner's language.
`page_url`	`string`	Nem	—

Válasz

Név	Típus	Kötelező	Mi ez
`conversation_id`	`string`	Igen	—
`reply`	`string`	Igen	—
`citations`	`object[]`	Igen	The pages of this site the answer was drawn from.
`handoff_suggested`	`boolean`	Igen	⛔ 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>`	Nem	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`	Nem	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,…

Hibák, amelyeket ez a végpont visszaadhattatlan

404 · 429

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