Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json
metadata
object

Set of key-value pairs you can attach to the object — store your own system's IDs or grouping labels. Keys max 40 chars (up to 50 keys), values stored as strings max 500 chars. On update, keys merge individually; set a key to null or "" to remove it. Echoed back on reads and in webhook payloads.

Response

AI site created. When created with a prompt, an engineering build is started automatically — build_task_id references it; track progress via GET /tasks/{id}. Do not start another build for the site.

id
string
required
object
string
required
name
string
required
access_mode
enum<string>
required
Available options:
public,
members,
account,
admins_only,
me_only
subdomain
string | null
required
github_repo_full_name
string | null
required
metadata
object
required
domain
string | null
required
github_url
string | null
required
domain_verified
boolean
required
app_url
string | null
required
is_live
boolean
required
show_referral_badge
boolean
required
build_task_id
string | null
required
created_at
string
required