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 ਕੰਸੋਲ ਤੁਹਾਡੀ ਅਸਲ ਸੰਸਥਾ ਆਈਡੀ (organisation 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

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