Websites

Create a website

Creates a website in the organization. Provide either a name (trimmed, 1–200 characters) or a creation prompt; a prompt returns immediately with the temporary name Untitled site, which the built-in naming request attempts to replace on its next run together with a matching available slug and platform hostname. The hostname receives a short suffix when the clean hostname is unavailable. An omitted slug is allocated from the initial name; an explicit slug must be lowercase, URL-safe, unreserved, and unique among active websites in the organization. The website starts as an unpublished draft at headVersion 1. Send an idempotencyKey to make retries return the same website. Edit its source through the Source code operations, then publish with websiteSourceCode.head.publish.

post/websites

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/websites
  • Auth: HTTP bearer

Request body

organizationIdstring required
namestring
promptstring
slugstring
idempotencyKeystring

Caller-generated key, such as a UUID, that makes creation safe to retry. Send the same key on every retry of one creation attempt: when this organization already has a website created with the key, that website is returned and no second website is created. A key whose website is in the trash returns a 409 with idempotencyKeyStatus: "deleted"; retry with a new key.

Response

The newly created website, or the website an earlier request with the same idempotencyKey created.

idstring required

Unique website id.

organizationIdstring required

Id of the organization that owns the website.

namestring required

Display name, 1–200 characters.

slugstring required

URL-safe identifier unique among active websites in the organization.

customDomainsEnabledboolean required

Whether custom domains are enabled. Enabling is owner-only and makes the website a billable site; custom domains can only be attached while true.

headVersioninteger required

Latest draft source version number; starts at 1.

publishedVersioninteger nullable required

Currently published version. null when the website is not published.

createdAtstring date-time required

When the website was created.

updatedAtstring date-time required

When the website was last modified.

Changes

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