GET `/v1/ai/site-builds`

The organization's AI-built sites, its trial state and its builder spend.

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/ai/site-builds \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

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`.

Parameters

Name	Type	Required	What it is
`org_id (query)`	`Uuid`	No	Which organization this is about. Required when the caller belongs to more than one; a caller in exactly one may omit it.

Response

Name	Type	Required	What it is
`builds`	`SiteBuild[]`	Yes	—
`trial`	`SiteBuilderTrial`	Yes	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`	Yes	The organization's AI credit balance, USD micros.
`spend_micros`	`integer`	Yes	What this organization has spent on the builder in total, USD micros.

Errors this endpoint can return

401 · 403 · 422 · 429