public
POST /v1/public/assistant/ask
Ask Zinn® a pre-sales question — no account, one grounded answer.
Аутентификација
Ова крајња тачка је јавна. Не захтева никакве акредитиве нити организацију — то је оно што читају наш сопствени маркетиншки сајт и машине за одговоре са вештачком интелигенцијом.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
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