Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.create; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/ai/site-builds \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "brief": <string> }'Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Accepts a brief and returns the new draft **at once, in `generating`, with no files yet**. A durable workflow writes the site — a real multi-page site takes one to three minutes, which no request can hold (D20191) — and the row settles to `drafted`, or to `failed` with a reason in `error`. Poll `listSiteBuilds` or `getSiteBuild` to watch it. Nothing is public until `publishSiteBuild` is called. The model is the **cheapest priced one the catalogue has verified** for the funding provider unless `model` names another (§2.45); the choice is recorded on the row. **The first build on an organization posts its one-time free allowance before the spend is authorised**, so a brand-new customer's first build succeeds rather than being refused and then handed credit they cannot retroactively use. The grant is made one-time by a database constraint, not by application code. Billed on **actual** token usage against the ordinary AI credit balance, or against the customer's own provider key when they have one — the same one meter every other AI surface uses. Refuses rather than truncating: a site that overran the size cap, that named an unusable file path, or that came back without a home page is reported as a `422` with a reason, because a half-written site that renders is worse than none — the customer would publish it. Requires `sites.create`, which is a stronger authority than reading a draft needs: this call spends the organization's money.
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
brief | string | Да | What the site is for, who it is for, and which pages it needs. A tighter brief produces a better site than a longer one. |
provider | string | Не | Force a provider. Omit for the cheapest route this organization's funding allows, resolved exactly as every other customer-funded AI surface resolves it. |
model | string | Не | Force a model. Omit to let the resolver choose. |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
build | SiteBuild | Да | One "describe a site and we build it" run. `files` is present on the **detail** and create responses and absent from the **list**, deliberately: a generated tree can be a hundre… |
trial | SiteBuilderTrial | Не | The **one-time** free allowance for the AI site builder. One grant per organization, for ever — not monthly, and not per site. `granted` is true because the credit was actually… |
Грешки, които този крайpoint може да върне
401 · 403 · 422 · 429