認証
ベアラー トークンとして API キーを送信します。キーには sites.create 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織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.
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 hundred… |
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… |
このエンドポイントが返すエラー
401 · 403 · 422 · 429