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

التفاصيل

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