Skip to main content
POST
Create a tent

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Body

application/json
name
string
required

Tent name.

Minimum string length: 1
prompt
string

Generation prompt. Required unless template_id is provided (then it describes the customization to apply).

Minimum string length: 1
user_id
string

External identifier recorded as the creator of the generation. Does not affect authentication or scope.

include_brand
boolean

Pull workspace brand context (logo, colors, company info, brand guidelines) into the generation.

template_id
string

Create from an approved template in the same workspace.

auto_publish
boolean

Publish automatically after a successful generation.

custom_page_alias
string

Custom published alias: max 100 characters; lowercase letters, numbers, hyphens, underscores, and dots; must start with a letter or number; must not be a UUID or a reserved word (api, admin, submit, assets, …). Use / to publish at the domain root. Requires auto_publish: true.

Maximum string length: 100
token_data
object

Structured personalization data made available to the generation as tokens.

input_data
object
deprecated

Deprecated alias of token_data.

tent_id
string<uuid>

Generate into an existing idle tent — use this after uploading assets to /v1/tents/new/assets.

asset_ids
string[]

Up to 5 uploaded asset IDs to reference. Requires tent_id.

Maximum array length: 5

Response

Template copied synchronously (template create without a prompt).

id
string<uuid>
required

Tent ID.

status
string
required

Always completed for a synchronous template copy.

created_at
string<date-time>
required

Creation time.

generation_id
string

Generation ID.

publication
object

Publication state for a tent generation.