ai
GET /v1/ai/site-builds
The organization's AI-built sites, its trial state and its builder spend.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/ai/site-builds \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Every draft this organization has built, newest first, capped at 50. `files` is deliberately **omitted** from each row here and present on `getSiteBuild` — a generated tree can be a hundred kilobytes and thirty of them inlined is a response no client can render. Read `file_count` for a list, and fetch one build for its contents. `trial` answers whether the one-time free allowance has been used. Requires `sites.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | Uuid | いいえ | Which organization this is about. Required when the caller belongs to more than one; a caller in exactly one may omit it. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
builds | SiteBuild[] | はい | — |
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… |
balance_micros | integer | はい | The organization's AI credit balance, USD micros. |
spend_micros | integer | はい | What this organization has spent on the builder in total, USD micros. |
このエンドポイントが返すエラー
401 · 403 · 422 · 429