Skip to main content
POST
Remix references

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json
sources
object[]
required

One to ten references. url is fetched and transcribed for you; transcript is used as sent.

Required array length: 1 - 10 elements
instructions
string
required

What the new script should do differently.

Required string length: 1 - 4000
language
string
Required string length: 1 - 60
outputFormat
enum<string>
Available options:
script,
scenes
targetPlatform
enum<string>
Available options:
tiktok,
reels,
shorts,
youtube,
twitter,
general
niche
string
Maximum string length: 200
suggestedDurationSeconds
integer
Required range: 5 <= x <= 3600
projectId
string

The project to file this work under. Optional: omit it and one is created for you, and its id comes back on the response — read it from there rather than assuming. Pass the same id across calls when you want the script, the render and the thumbnail to land in one container. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200

Response

Success.

success
boolean
required
projectId
string
required

The project this work was filed under. Read it from here — a call that sent no projectId had one created, and this is where its id comes back.

Example:

"prj_9x2a4c"

credits
number
required

What this call actually cost, which is not always what was quoted.

Example:

300

remix
any
required

The synthesised script, or scenes when outputFormat asked for them.

creditBalance
number

Your balance after the charge. Absent when billing is disabled for the workspace.

Example:

3900

{key}
any