hosting

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

Ask the AI assistant about one file in the site's web editor.

모든 hosting 엔드포인트

인증

이 엔드포인트는 공개되어 있습니다. 자격 증명이나 조직 정보가 필요하지 않으며, 당사의 마케팅 사이트와 AI 답변 엔진이 읽는 것과 동일합니다.

이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/ide-assist \
  -H "Content-Type: application/json" \
  -d '{ "context": <string> }'

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요

상세 정보

Answers one request about one file, from inside the site's browser editor, and bills the model call to that site's organisation on the same AI meter as every other surface (their own provider key if they have added one, their Zinn® credit if not). **This is the one site endpoint family with no user session behind it, and that is deliberate.** Its caller is a VS Code extension running inside the customer's own CageFS jail on a hosting box, which cannot hold a Keycloak session. It authenticates with a **signed, site-bound, expiring grant** minted when the editor is opened and presented as `Authorization: Bearer <grant>`. The grant names the site, the organisation and the person who opened the editor; the site in it must match the site in the path, and the organisation is read from the grant and never from the request body, so a grant for one site can neither ask about another nor bill another tenant. The grant never reaches the customer's browser: it is held in a root-owned file on the hosting box and attached by the editor gate, which runs outside every jail. A missing or unreadable grant is a `404`, never a `401`, so this cannot be used to discover that a site exists. An **editing** action (`fix`, `refactor`, `complete`, `generate`) returns a `proposal`: the complete replacement for the region that was sent. It is a suggestion and nothing on this side applies it — the editor shows it as a diff and writes it only after the customer approves. A **read-only** action (`ask`, `explain`) never returns one, however code-shaped its answer. A refusal the customer should read — an exhausted allowance, a revoked provider key, a question that is too long, a file too large to rewrite safely — is a `422` carrying the sentence to show them and a code in `details[].code`, because "you are out of credit" and "we could not reach the model" are different facts and only one of them is theirs to fix.

매개변수

이름유형필수설명
siteId (path)UuidSite ID (UUIDv7).

요청 본문

이름유형필수설명
actionstring<ask, explain, fix, refactor, complete, generate>아니요What to do. `ask` and `explain` are read-only and answer in prose. `fix`, `refactor`, `complete` and `generate` return a `proposal` the editor shows as a diff for the customer t…
questionstring아니요What the developer wants. Required for `ask` and `generate`; optional for the rest. Longer than 4,000 characters is a `422` asking them to select the part of the file they mean.
pathstring아니요The file's path relative to the site, shown to the model so it can reason about what kind of file it is. Optional — an unsaved buffer has none.
contextstringThe file, or the selected region of it. Truncated to 24,000 characters for a read-only action, and the answer says so rather than silently answering about a fragment. An **editi…
modelstring아니요A model from `/ide-assist/models`. Omit for the automatic choice, which is the cheapest model that can do the job, computed from our price list.

응답

이름유형필수설명
actionstringThe action this answers, echoed so the editor can render it correctly.
answerstringThe assistant's answer, as markdown. Never blank on a `200` — an empty answer is a `422`, because the call was paid for either way and a blank panel in an editor is indistinguis…
proposalstringThe complete replacement for the region that was sent, or empty. Non-empty only for an editing action, and only when the model returned exactly one well-formed code block with n…
modelstringThe model that answered, so the editor can show what the customer paid for.
fundingstringWhich route paid — the customer's own provider key, their Zinn® credit, or their included allowance. The same decision the AI page renders, never a second one.

이 엔드포인트가 반환할 수 있는 오류

404 · 422 · 429