Skip to main content
POST
/
sites
Typescript (SDK)
import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.sites.create({});

  console.log(result);
}

run();
{
  "id": "<string>",
  "object": "<string>",
  "name": "<string>",
  "subdomain": "<string>",
  "github_repo_full_name": "<string>",
  "domain": "<string>",
  "github_url": "<string>",
  "domain_verified": true,
  "app_url": "<string>",
  "is_live": true,
  "show_referral_badge": true,
  "build_task_id": "<string>",
  "created_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
​
prompt
string

Build brief describing the storefront to generate — brand, what you're selling, and the look and feel. Kicks off an AI build. Required unless repository is given.

​
repository
string

Optional "owner/repo" of an existing GitHub repository (reached through a connected GitHub App installation) to start the site from instead of generating a fresh one. When set, prompt is optional and only tells the agent what to adapt.

​
name
string
​
access_mode
enum<string>
Available options:
public,
account,
admins_only,
me_only
​
show_referral_badge
boolean

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,
account,
admins_only,
me_only
​
subdomain
string | null
required
​
github_repo_full_name
string | null
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