public

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

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

Санҷиши ҳаққоният

Ин нуқтаи поёни оммавӣ аст. Он ҳеҷ гуна маълумоти эътимоднок ва ҳеҷ гуна созмонро талаб намекунад — он ҳамон чизест, ки сайти маркетингӣ ва муҳаррикони ҷавоби сунъии худи мо мехонанд.

Ин нуқтаи поёнӣ ягон рақами мушаххаси созмонро талаб намекунад. Калиди шумо аллакай созмонеро, ки ба он тааллуқ дорад, муайян мекунад ва ҷавоб ба он маҳдуд карда мешавад.

Санҷидан

Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.

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

Воarid шудаед? Консоли 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.

Параметрҳо

Ном	Намуд	Талаб карда мешавад	Ин чӣ аст
`publicKey (path)`	`string`	Бале	The agent's public key, as carried in the embed snippet.

Ҷисми дархост

Ном	Намуд	Талаб карда мешавад	Ин чӣ аст
`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`	Не	—

Ҷавоб

Ном	Намуд	Талаб карда мешавад	Ин чӣ аст
`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