public

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

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

ማረጋገጫ

ይህ ማቆሚያ (endpoint)ይፋዊ ነው። ምንም ምስክርነት (credential) ወይም ድርጅት አይወስድም — የራሳችን የግብይት ጣቢያ እና የAI መልስ ሞተሮች የሚያነቡት ነው።

ይህ ኤንድፖይ መክፈቻ (endpoint) የድርጅት መታወቂያ (organisation id) አይወስድም። የእርስዎ ቁልፍ (key) እሱ የሚመለከተውን ድርጅት አስቀድሞ ይለያል፣ እና ምላሹም ለዚሁ የተወሰነ ነው።

ሞክሩት

በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።

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

ገብተዋል? የመቆጣጠሪያ ማዕከልዎ ውስጥ ያለው የኤፒአይ ኮንሶል ትክክለኛውን የድርጅት መታወቂያዎን እና የራስዎን ቁልፍ ይሞላል፣ እና ትክክለኛውን ምላሽ ማየት እንዲችሉ ጥያቄውን በቀጥታ ከሚሰራው ኤፒአይ ጋር ያካሂደዋል። ይህን ኤንድፖይንት በ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