public
POST /v1/public/assistant/ask
Ask Zinn® a pre-sales question — no account, one grounded answer.
ప్రమాణీకరణ
ఈ ఎండ్పాయింట్ పబ్లిక్. దీనికి ఎలాంటి ఆధారాలు మరియు సంస్థ అవసరం లేదు — మన స్వంత మార్కెటింగ్ సైట్ మరియు AI సమాధాన ఇంజిన్లు చదివేది ఇదే.
ఈ ఎండ్పాయింట్ ఎలాంటి సంస్థ ఐడీని తీసుకోదు. మీ కీ ఇప్పటికే అది ఏ సంస్థకు చెందుతుందో గుర్తిస్తుంది మరియు ప్రతిస్పందన దానికే పరిమితం చేయబడుతుంది.
ప్రయత్నించండి
కోణీయ బ్రాకెట్లలో ఉన్న దేన్నైనా మీ స్వంత విలువలతో భర్తీ చేయండి, మరియు కీ ప్లేస్హోల్డర్ను మీ డాష్బోర్డ్ నుండి తీసుకున్న కీతో భర్తీ చేయండి.
curl -X POST https://api.zinndigital.com/v1/public/assistant/ask \
-H "Content-Type: application/json" \
-d '{ "question": <string> }'సైన్ ఇన్ చేశారా? మీ డ్యాష్బోర్డ్లోని API కాన్సోల్ మీ అసలైన సంస్థ ID మరియు మీ స్వంత కీని నింపుతుంది, అలాగే మీరు అసలైన ప్రతిస్పందనను చూడటానికి లైవ్ API ద్వారా ఆభ్యర్థనను రన్ చేస్తుంది. ఈ ఎండ్పాయింట్ను API కన్సోల్లో తెరిచండి
వివరాలు
Anonymous — no credential, no tenant, nothing stored. The public half of Ask Zinn®: a visitor deciding whether to buy asks a question, and the answer is built from PUBLISHED knowledge-base articles plus the LIVE catalogue read at request time, so a price it quotes is the price the engine will charge. ⛔ It answers only from that material. grounded: false is the assistant saying it could not — a successful response whose correct rendering is a route to a human, never an error banner. A client that renders it as a failure has inverted the one property this surface exists to give (§2.44, §2.57). ⛔ It cannot read a site, a ticket, an invoice or an org: no identifier for one is accepted anywhere on this path. Anything about an existing account comes back grounded: false. ⛔ history is supplied by the CALLER because nothing is persisted — there is no account to hang a conversation on. It is bounded here and again in the engine. Charged against a fail-closed per-IP and global budget before the body is parsed, because every call is a paid model call.
అభ్యర్థన బాడీ
| పేరు | రకం | కావలసినది | ఇది ఏమిటి |
|---|---|---|---|
question | string | అవును | What the visitor asked, in their own language. ⛔ Shorter than the dashboard assistant's 4,000: a customer pastes an error log, a prospect asks a question, and an unbounded prompt… |
locale | string | కాదు | Which translation of a knowledge-base article to retrieve, and the language to answer in. An unknown value falls back to English rather than failing. |
currency | string | కాదు | Which currency's catalogue prices reach the answer. ⛔ A hint, not a filter: a plan that carries no price in this currency is quoted in one it does have, clearly labelled, because… |
history | PresalesTurn[] | కాదు | Earlier turns, oldest first. ⛔ The CALLER holds these because nothing is stored — there is no account to hang a conversation on and no lawful basis to keep one. They are therefore… |
స్పందన
| పేరు | రకం | కావలసినది | ఇది ఏమిటి |
|---|---|---|---|
answer | string | అవును | The reply, in the language the visitor wrote in. |
grounded | boolean | అవును | True when the answer came from the supplied articles and catalogue. False when the assistant said it could not answer from them — which is the honest outcome and the one this… |
citations | string[] | అవును | Slugs of published articles the answer used, for /kb/{slug}. ⛔ Filtered to the ones actually supplied to the model, so a fabricated citation can never render as a link to a 404. |
plan_codes | string[] | అవును | Catalogue plan codes the answer recommends or prices, filtered the same way. The site turns these into links to the page that sells them. |
plans | object[] | అవును | The plans in plan_codes, in the same order, with the name a visitor sees. ⛔ A code is an internal identifier and is never shown; the answer text has already had every supplied… |
ఈ ఎండ్పాయింట్ తిరిగి ఇవ్వగల లోపాలు
422 · 429 · 503