public

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

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

Autentifikacija

Ova je krajnja točka javna. Ne zahtijeva nikakve vjerodajnice ni organizaciju – to je ono što čitaju naše vlastite marketinške stranice i AI strojevi za odgovore.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Parametri

Naziv	Vrsta	Obavezno	Što je to
`publicKey (path)`	`string`	Da	The agent's public key, as carried in the embed snippet.

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`message`	`string`	Da	—
`conversation_id`	`string`	Ne	Continue an existing thread. Omit to start one.
`locale`	`string`	Ne	The visitor's language. The agent answers in this, not in the site owner's language.
`page_url`	`string`	Ne	—

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`conversation_id`	`string`	Da	—
`reply`	`string`	Da	—
`citations`	`object[]`	Da	The pages of this site the answer was drawn from.
`handoff_suggested`	`boolean`	Da	⛔ 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>`	Ne	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`	Ne	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,…

Pogreške koje ova krajnja točka može vratiti

404 · 429

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