POST `/v1/ai/site-builds`

Describe a site and the AI builds it.

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền sites.create; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.

Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

curl -X POST https://api.zinndigital.com/v1/ai/site-builds \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "brief": <string> }'

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

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.

Nội dung yêu cầu

Tên	Loại	Bắt buộc	Nội dung này là gì
`brief`	`string`	Có	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`	Không	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`	Không	Force a model. Omit to let the resolver choose.

Phản hồi

Tên	Loại	Bắt buộc	Nội dung này là gì
`build`	`SiteBuild`	Có	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`	Không	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…

Các lỗi điểm cuối này có thể trả về

401 · 403 · 422 · 429

POST /v1/ai/site-builds