public

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

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

Όλα τα τελικά σημεία public

Όλα τα έγγραφα προγραμματιστών

Πισtoποίηση

Αυτό το τελικό σημείο είναι δημόσιο. Δεν απαιτεί διαπιστευτήρια ούτε οργανισμό — είναι αυτό που διαβάζουν ο δικός μας ιστότοπος μάρκετινγκ και οι μηχανές απαντήσεων τεχνητής νοημοσύνης.

Αυτό το τελικό σημείο δεν δέχεται αναγνωριστικό οργανισμού. Το κλειδί σας προσδιορίζει ήδη τον οργανισμό στον οποίο ανήκει, και η απάντηση περιορίζεται σε αυτόν.

Δοκιμάστε το

Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.

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

Συνδεθήκατε; Η κονσόλα 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.

Παράμετροι

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
publicKey (path)stringΝαιThe agent's public key, as carried in the embed snippet.

Σώμα αίτησης

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
messagestringΝαι
conversation_idstringΌχιContinue an existing thread. Omit to start one.
localestringΌχιThe visitor's language. The agent answers in this, not in the site owner's language.
page_urlstringΌχι

Απάντηση

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
conversation_idstringΝαι
replystringΝαι
citationsobject[]ΝαιThe pages of this site the answer was drawn from.
handoff_suggestedbooleanΝαι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…
refusalstring<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;…
failureVendorFailureΌχι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