public

POST `/v1/public/assistant/ask`

Ask Zinn® a pre-sales question — no account, one grounded answer.

Аутентификация

Этот эндпоинт является публичным. Он не требует учетных данных и организации — его читают наш собственный маркетинговый сайт и поисковые системы на базе ИИ.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X POST https://api.zinndigital.com/v1/public/assistant/ask \
  -H "Content-Type: application/json" \
  -d '{ "question": <string> }'

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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

POST /v1/public/assistant/ask