ai

POST /v1/ai/site-builds

Describe a site and the AI builds it.

所有 ai 端点

所有开发者文档

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.create 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

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 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 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.

请求正文

名称类型必填内容简介
briefstringWhat the site is for, who it is for, and which pages it needs. A tighter brief produces a better site than a longer one.
providerstringForce a provider. Omit for the cheapest route this organization's funding allows, resolved exactly as every other customer-funded AI surface resolves it.
modelstringForce a model. Omit to let the resolver choose.

响应

名称类型必填内容简介
buildSiteBuildOne "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 hundred…
trialSiteBuilderTrialThe 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…

此端点可能返回的错误

401 · 403 · 422 · 429