Skip to main content
POST
Create a new website from scratch

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Create a website

companyId
string
required

Company ID that owns the website

name
string

Website name (default "Untitled website")

description
string

Optional short description

seedPrompt
string

What the site is for. Used only to name the site when name is omitted; it does not build any pages.

brandKitId
string

Brand kit to design with (an id from brand_kit_listBrandKits). Wins over designStyleId and colorPalette. Omit all three to use the company's default kit.

designStyleId
string

Design style the site is designed in, when no brand kit is given. Get ids from design_styles_listDesignStyles with medium=website and pick the style whose name, category and description fit the site.

colorPalette
object

Colors to use when no brand kit is given: {primary, secondary, accent, background, surface, text} as hex values. Combines with designStyleId.

useCompanyContext
boolean

Let the site builder use the company profile as context

Response

The new website

The new website. Its id is the websiteId for every other Websites action.

id
string
name
string