hosting

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

One turn of the web editor's AI chat.

Minden hosting végpont

Hitelesítés

Ez a végpont nyilvános. Nem igényel hitelesítő adatot és szervezetet sem – ezt olvassa a saját marketingoldalunk és az MI-válaszadó motorunk is.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

NévTípusKötelezőMi ez
siteId (path)UuidIgenSite ID (UUIDv7).

Kérés törzse

NévTípusKötelezőMi ez
messagesIdeChatMessage[]IgenThe conversation so far. The engine is stateless, so the whole transcript arrives on every call and the caller bounds it.
toolsIdeChatToolOffer[]NemWhat 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…
pathstringNemThe file the customer is looking at, if any.
contextstringNemThat file's contents, truncated to the assistant's context cap.
modelstringNemA model from `/ide-assist/models`. Omit for the automatic choice, which is the cheapest priced model the organisation can run.

Válasz

NévTípusKötelezőMi ez
answerstringIgenEmpty 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_callsIdeChatToolCall[]Igen
modelstringIgen
fundingstringIgenWhich 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.
turnsintegerIgenHow 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.

Hibák, amelyeket ez a végpont visszaadhattatlan

404 · 422 · 429