Skip to main content
POST
Start creative session

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

campaignId
string
required
Minimum string length: 1

Body

application/json
providerType
enum<string>
required

Creative provider type.

Available options:
amazon,
audiostack,
elevenlabs,
fal,
gemini,
google,
linkedin,
meta,
openai,
openai_ads,
pinterest,
reddit,
snap,
spotify,
tiktok,
veo
request
object
required

Provider-neutral creative request.

storefrontId
integer

Connected seller storefront, when the engine requires one.

Required range: 0 < x <= 9007199254740991
language
string

Requested BCP-47 language for generated audio. Supported language families are English (en), Dutch (nl), Spanish (es), and Portuguese (pt), such as pt-BR.

Required string length: 2 - 35
externalAccountId
string

Connected external account identifier.

Minimum string length: 1
title
string

Creative brief title.

Required string length: 1 - 255
persona
string

Intended audience persona.

Required string length: 1 - 255
brand
string

Brand for the creative.

Required string length: 1 - 255
objective
string

Creative objective.

Required string length: 1 - 2000
prompt
string

Creative prompt.

Required string length: 1 - 5000
source_asset
object

Primary locked reference asset.

assets
object[]

Reference assets for the session.

renditions
object[]

Derived reference-asset renditions.

partial_success
boolean
default:true

Whether partial generation success is acceptable.

Response

Start creative session

creative_session_id
string
required
campaign_id
string
required
title
string
required
persona
string
required
brand
string
required
objective
string
required
prompt
string
required
status
enum<string>
required
Available options:
drafting,
refining,
evaluating,
finalized
flow
object[]
required
variants
object[]
required
format_renders
object[]
required
engine
object
presentation
enum<string>
Available options:
generative-widgets
brand_reference
object
accumulated_feedback
string[]
source_asset
object
asset_store
object
creative_plan
object
required_placements
object[]
renderer_capabilities
object[]
rendering_model
object
selected_variant_id
string
refined_variant_id
string
approval
object
next_steps
object[]
notices
object[]
finalization
object