Skip to content

Generate Org Video

POST
/org-videos/generate

Render a storyboard of ready clips into a library video (charges the render fee).

Returns at once with the video queued; poll GET /org-videos/{video_id}.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
storyboard
required
object
copy

Copy slot id -> text. The plain template renders none.

object
key
additional properties
string
shots
Array<object>
object
clip_id
required

A READY Studio clip.

string
in_s
Any of:
number
out_s
Any of:
number
> 0
template_id
string
default: plain >= 1 characters <= 40 characters
title
Any of:
string
<= 255 characters

Responses

200

Successful Response

object
data
required

A library video. generation carries render progress for generated videos.

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