public

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

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

Tabbatar da Asali

Wannan yankin ƙarshen jama'a ne. Ba ya ɗaukar wata takardar shaida ko ƙungiya — shi ne abin da shafin kasuwancinmu da injunan amsa na AI ke karantawa.

Wannan wurin ƙarewa ba ya buƙatar ID na ƙungiya. Maɓallin ku ya riga ya gano ƙungiyar da yake ciki, kuma an iyakance amsa a kanta.

Gwada

May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.

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

An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API

Bayani

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.

Sigogi

Suna	Nau'i	Ana buƙata	Abin da yake
`publicKey (path)`	`string`	Eh	The agent's public key, as carried in the embed snippet.

Jikin buƙata

Suna	Nau'i	Ana buƙata	Abin da yake
`message`	`string`	Eh	—
`conversation_id`	`string`	A'a	Continue an existing thread. Omit to start one.
`locale`	`string`	A'a	The visitor's language. The agent answers in this, not in the site owner's language.
`page_url`	`string`	A'a	—

Martani

Suna	Nau'i	Ana buƙata	Abin da yake
`conversation_id`	`string`	Eh	—
`reply`	`string`	Eh	—
`citations`	`object[]`	Eh	The pages of this site the answer was drawn from.
`handoff_suggested`	`boolean`	Eh	⛔ 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>`	A'a	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`	A'a	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,…

Kuskuren da wannan matsaya za ta iya maido wa

404 · 429

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