Skip to content

Generate Video Clip

POST
/ad-creatives/video/clips

Generate one video clip. SPENDS CREDIT - priced per second of footage.

ASYNCHRONOUS: the clip is queued and returned at once; poll GET /ad-creatives/video/clips/{clip_id}. An org can have only a few clips generating at a time - over that cap is a 429.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Generate one video clip. SPENDS CREDIT - priced per second of footage.

object
aspect_ratio
string
default: 16:9
Allowed values: 16:9 9:16
creative_id
Any of:
string
duration_seconds
integer
default: 8
prompt_final
Any of:
string
<= 1000 characters
prompt_inputs
required

The structured shot description. subject is the only required field.

object
camera
Any of:
string
<= 40 characters
lighting
Any of:
string
<= 120 characters
negative
Any of:
string
<= 300 characters
setting
Any of:
string
<= 300 characters
style
Any of:
string
<= 40 characters
subject
required
string
>= 3 characters <= 500 characters
reference_image_urls
Array<string>
<= 3 items
start_image_url
Any of:
string
<= 2000 characters

Responses

202

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string