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…
`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.
`credit`	`IdeAssistCredit`	Да	The balance after this turn, so the editor's running total moves with the question that spent it rather than lagging one call behind.

Ошибки, которые может возвращать этот эндпоинт

404 · 422 · 429

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