Skip to main content
POST
Remix references

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string

Stable retry key for this logical paid call. Reuse it after a timeout to receive the original result without duplicate work or spend.

Required string length: 1 - 255
x-sigmora-quote-only
string

Send 1 to get the price, balance and budget verdict without running anything.

Allowed value: "1"
x-sigmora-max-credits
string

The approved price; a call that would cost more is refused and nothing is charged.

Pattern: ^\d+$

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
projectId
string
required

The existing project to file this work under. Create it with POST /v1/projects, then reuse its id across related calls. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200
language
string

Output language. Defaults to English.

Required string length: 1 - 60
outputFormat
enum<string>

Return one continuous script or a scene-by-scene structure. Defaults to script.

Available options:
script,
scenes
targetPlatform
enum<string>

Platform conventions to write for. general is platform-neutral and is the default.

Available options:
tiktok,
reels,
shorts,
youtube,
twitter,
general
niche
string

Subject area for terminology and framing.

Maximum string length: 200
brandContext
string

Anything the writer should know about your brand: voice, claims, things to avoid. It shapes the new script; it is never treated as source material.

Maximum string length: 4000
verify
boolean

Fact-check the finished script against public sources before it is returned. A script whose hook or thesis cannot be verified is withheld and nothing is charged. Without web search configured the script is returned unchecked, with a warning in gate.

suggestedDurationSeconds
integer

Target runtime for the resulting script, in seconds. 5 to 3,600.

Required range: 5 <= x <= 3600

Response

Success.

success
boolean
required
credits
number
required

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

Example:

300

remix
object
required

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

projectId
string

The existing project this work was filed under. It matches the projectId supplied by the caller after workspace ownership was verified.

Example:

"prj_9x2a4c"

creditBalance
number

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

Example:

3900

gate
object

Present when verify was sent. A script the check did not clear is never returned (and never charged).

{key}
any