hosting
POST /v1/sites/{siteId}/ide-chat
One turn of the web editor's AI chat.
ప్రమాణీకరణ
ఈ ఎండ్పాయింట్ పబ్లిక్. దీనికి ఎలాంటి ఆధారాలు మరియు సంస్థ అవసరం లేదు — మన స్వంత మార్కెటింగ్ సైట్ మరియు AI సమాధాన ఇంజిన్లు చదివేది ఇదే.
ఈ ఎండ్పాయింట్ ఎలాంటి సంస్థ ఐడీని తీసుకోదు. మీ కీ ఇప్పటికే అది ఏ సంస్థకు చెందుతుందో గుర్తిస్తుంది మరియు ప్రతిస్పందన దానికే పరిమితం చేయబడుతుంది.
ప్రయత్నించండి
కోణీయ బ్రాకెట్లలో ఉన్న దేన్నైనా మీ స్వంత విలువలతో భర్తీ చేయండి, మరియు కీ ప్లేస్హోల్డర్ను మీ డాష్బోర్డ్ నుండి తీసుకున్న కీతో భర్తీ చేయండి.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/ide-chat \
-H "Content-Type: application/json" \
-d '{ "messages": <IdeChatMessage[]> }'సైన్ ఇన్ చేశారా? మీ డ్యాష్బోర్డ్లోని API కాన్సోల్ మీ అసలైన సంస్థ ID మరియు మీ స్వంత కీని నింపుతుంది, అలాగే మీరు అసలైన ప్రతిస్పందనను చూడటానికి లైవ్ 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