hosting

POST `/v1/sites/{siteId}/ide-chat`

One turn of the web editor's AI chat.

Автентифікація

Ця кінцева точка є публічною. Вона не потребує жодних облікових даних чи організації — це те, що читають наш власний маркетинговий сайт та пошукові системи на основі штучного інтелекту.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/ide-chat \
  -H "Content-Type: application/json" \
  -d '{ "messages": <IdeChatMessage[]> }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

The conversation panel inside the site's web editor. Unlike `askSiteIdeAssistant` — which answers one question about one file — this carries a transcript and a catalogue of **tools** the editor is willing to run, so the assistant can answer questions about the customer's own hosting rather than only about their code. Authenticated by the same signed, site-bound grant as the rest of the editor's endpoints, and metered to the same organisation on the same `web_ide` surface. The model is the organisation's own choice, or the cheapest priced one when they have expressed none — Claude, ChatGPT, Gemini or Grok, funded from Zinn® credit or the customer's own provider key. **The engine never runs a tool.** When the model asks for one, the response carries `tool_calls` and an empty `answer`, and the conversation is unfinished: the editor invokes them through its own MCP client — where the customer's confirmation happens for anything destructive, and where the MCP server's write gate and spend caps apply — and posts the results back on the next turn. A response with an empty `answer` and no `tool_calls` is never returned; that is a `422` carrying its own sentence, because the call was paid for either way and a blank panel is indistinguishable from a broken one. The transcript is authored inside the customer's own jail, so it is treated as data: roles are mapped from a closed set, the tool list is bounded and coerced, and a malformed tool is dropped rather than offered.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`siteId (path)`	`Uuid`	Так	Site ID (UUIDv7).

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`messages`	`IdeChatMessage[]`	Так	The conversation so far. The engine is stateless, so the whole transcript arrives on every call and the caller bounds it.
`tools`	`IdeChatToolOffer[]`	Ні	What the editor can run — its MCP servers' tools and any the customer's own extensions contribute. Bounded and coerced on arrival; a malformed entry is dropped rather than offer…
`path`	`string`	Ні	The file the customer is looking at, if any.
`context`	`string`	Ні	That file's contents, truncated to the assistant's context cap.
`model`	`string`	Ні	A model from `/ide-assist/models`. Omit for the automatic choice, which is the cheapest priced model the organisation can run.

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`answer`	`string`	Так	Empty when the assistant asked for tools instead. Never empty alongside an empty `tool_calls` — that is a `422` with its own sentence, because the call was paid for either way.
`tool_calls`	`IdeChatToolCall[]`	Так	—
`model`	`string`	Так	—
`funding`	`string`	Так	Which purse ran it — the same value the AI page renders, from the same decision. The editor shows "your Zinn® credit" or "your own API key" beneath the answer.
`turns`	`integer`	Так	How many turns of this conversation have already asked for tools, so the editor can stop a model that will not settle rather than paying for it indefinitely.

Помилки, які може повертати ця кінцева точка

404 · 422 · 429

POST /v1/sites/{siteId}/ide-chat