Objects

The shapes returned by the API. Endpoints that return one of these link here instead of repeating every field.

Scene

Returned by the Scenes endpoints. Some depth fields (compliance audit, approvals, A/B pairs, heatmap) are tier-gated and only present when the caller’s tier and the scene’s tier allow.

Fields

string

Scene ID.

workspaceId

string

Owning workspace.

tier

"TIER_1" | "TIER_2" | "TIER_3"

Processing tier (Basic / Premium / Ultimate).

status

"QUEUED" | "PROCESSING" | "READY" | "FAILED"

Pipeline status.

catalogStatus

"DRAFT" | "READY" | "SCHEDULED" | "LIVE" | "ARCHIVED"

Operator catalog status.

approvalState

"NONE" | "PENDING" | "APPROVED" | "BLOCKED"

Denormalized approval rollup.

filename

string

Original uploaded filename.

sceneName

string | null

URL-safe storage/display slug.

generatedTitle

string | null

LLM-generated short title.

titleSlug

string | null

Slug derived from the title.

shield

boolean

Shield compliance opt-in.

durationS

number | null

Duration in seconds (after processing).

qualityScore

number | null

Overall quality score 0–100.

qualityBreakdown

object | null

Sub-scores { lighting, camera, audio, overall } 0–10.

sizeBytes

string | null

File size in bytes (BigInt as string).

siteId

string | null

Paysite (Site.id) this scene belongs to.

batchId

string | null

Batch this scene was uploaded in.

rawMasterId

string | null

Source raw master, if any.

metadata

object

Pipeline output (title, tags, models, marketing copy…). NSFW fields stripped on TIER_1.

models

Model[]

Linked performers (when included).

createdAt

string (ISO)

Created timestamp.

updatedAt

string (ISO)

Last update timestamp.

processedAt

string (ISO) | null

Pipeline completion timestamp.

Model

Returned by the Models endpoints.

Fields

string

Model ID.

slug

string

Workspace-scoped kebab-case slug.

name

string

Display name.

aliases

string[]

Alternate names.

active

boolean

Active (vs archived) status.

studio

string | null

Studio attribution.

imageUrl

string | null

Public cover-image URL.

referenceImageUrl

string | null

Operator-uploaded reference photo URL.

qualityScore

number | null

Pipeline quality score 0–10.

sceneCount

number

Linked scene count.

records2257

boolean

§2257 record on file.

createdAt

string (ISO)

Created timestamp.

updatedAt

string (ISO)

Last update timestamp.

deletedAt

string (ISO) | null

Soft-delete timestamp (null if active).