Skip to Content
API referenceSites

Sites

The paysite network and its branded output — create sites, tune their voice, and manage intro/outro/watermark assets. Reads need scenes:read; writes need scenes:write.

List paysites with per-site scene counts + a network summary.

scenes:read
GET/v1/sites
Response fields
items
object[]
Sites: { id, slug, name, domain, niche, voiceTone, voiceLine, status, primary, sceneCount, createdAt, updatedAt }.
summary
object
{ siteCount, sceneCount }.
GET/v1/sites
Request
GET /v1/sites
Response
Press Run request to see the response

Get one paysite.

scenes:read
GET/v1/sites/{id}
Parameters
id
string · required
Site ID.
Response fields
id
string
Site ID.
slug
string
Site slug.
name
string
Site name.
domain
string
Site domain.
niche
string
Site niche.
voiceTone
string
Brand voice tone.
voiceLine
string
Brand voice tagline.
status
"LIVE" | "SETUP" | "RETIRED"
Site status.
primary
boolean
Whether this is the workspace primary site.
sceneCount
integer
Scenes on the site.
createdAt
string (ISO)
Created timestamp.
updatedAt
string (ISO)
Last update timestamp.

Create a paysite (slug auto-derives; voice inherits by default).

scenes:write
POST/v1/sites
Console roles: OWNER, DIRECTOR
Request body
name
string · required
Site name.
domain
string · required
Site domain.
slug
string
Site slug; auto-derived from name if omitted.
niche
string
Site niche.
voice
"inherit" | "clone" | "define" | "later"
Voice setup mode.
cloneFromSiteId
string
Source site to clone voice from (voice=clone).
voiceTone
string
Brand voice tone (voice=define).
voiceLine
string
Brand voice tagline (voice=define).

Returns the created site.

Update a paysite (slug not patchable).

scenes:write
PATCH/v1/sites/{id}
Console roles: OWNER, DIRECTOR
Parameters
id
string · required
Site ID.
Request body
name
string
Site name.
domain
string
Site domain.
niche
string
Site niche.
voiceTone
string
Brand voice tone.
voiceLine
string
Brand voice tagline.
watermarkAsset
string
Watermark asset reference.
status
"LIVE" | "SETUP" | "RETIRED"
Site status.

Returns the updated site.

Soft-delete a paysite (scenes keep their siteId; refuses the last site).

scenes:write
DELETE/v1/sites/{id}
Console roles: OWNER, DIRECTOR
Parameters
id
string · required
Site ID.
Response fields
deleted
boolean
True if deleted.
alreadyDeleted
boolean
True if it was already deleted.

Upload a branded-output asset (raw body) for one slot.

scenes:write
POST/v1/sites/{id}/output/{slot}
Console roles: OWNER, DIRECTOR
Parameters
id
string · required
Site ID.
slot
"intro" | "outro" | "watermark" · required
Output slot.

Returns the updated site.

Raw body stream. Content-Type must match the slot: video/mp4 for intro/outro, image/png for watermark.

Clear one branded-output slot.

scenes:write
DELETE/v1/sites/{id}/output/{slot}
Console roles: OWNER, DIRECTOR
Parameters
id
string · required
Site ID.
slot
"intro" | "outro" | "watermark" · required
Output slot.

Returns the updated site.

Last updated on
BatchesRaw masters