Sites

Create a site from a structured brief

Creates a site and starts generation in the background (typically ~60s). Returns 202 immediately; poll GET /api/v1/sites/{id} until status is ready. Requires scope sites:create.

post/api/v1/sites

Request

  • Base URL: https://app.mondovo.com
  • URL: https://app.mondovo.com/api/v1/sites
  • Auth: HTTP bearer

Request body

namestring required

Business / site name.

platform_gallery_use'confirmed' | 'declined'

Explicit permission to use real Mondovo template-gallery captures. Omit or set "declined" to keep gallery sourcing off.

brand_idstring uuid

Optional existing Brand Studio brand to link. Must belong to your organization. Omit to create a normal unlinked site.

pagesstring[]

Page names to create, e.g. ["home","about","contact"]. Omit to let Mondovo plan the site structure.

goalstring

The site’s primary conversion objective (e.g. "book a consultation"). Drives hero CTA and section selection. Omitted → inferred.

idempotency_keystring

Stable key for this creation attempt. Retrying a timed-out create with the SAME value returns the site the first attempt made instead of creating a duplicate. Use a fresh value (e.g. a UUID) per new site.

Response

Idempotent replay: a previous call with the same idempotency_key already created this site — that site is returned instead of a duplicate.

site_idstring uuid required
namestring required
status'generating' | 'refining' | 'ready' | 'publishing' | 'published' | 'publish_held' | 'error' required

"publish_held": the last publish crashed or rendered blank when loaded in a browser before going live, so it was not made live; deployment_url (if any) still serves the previous version. See publish_message.

publish_messagestring

Plain-language reason the last publish was held. Present only when status is "publish_held".

generation_progressnumber

0-100 while status is "generating".

generation_progress_messagestring

Human-readable progress note while generating.

preview_urlstring uri

Shareable public preview link (no login required). Omitted when previews are disabled.

editor_urlstring uri

Deep link into the Mondovo editor (requires login). Omitted while generating or errored.

deployment_urlstring uri

Live URL once published.

pagesstring[]

Slugs of the site’s pages (e.g. "/", "/about"). Omitted before generation completes.

error_messagestring

Present only when status is "error".

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.