Skip to main content
POST
Revise a video

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string
required

Required durable retry key. Reuse only for the identical logical request; a different payload returns conflict.

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

Send 1 to get the price and balance 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+$

Path Parameters

jobId
string
required

The jobId POST /v1/video/create returned (it starts vcj_).

Required string length: 1 - 200

Body

application/json
prompt
string

What to change. Omitted on a plan waiting for review: approve it as it is.

Required string length: 1 - 12000
projectId
string

Optional: the job already names its project. When sent, it must be that project.

Required string length: 1 - 200
aspect
enum<string>

The delivered frame: 9:16 (default), 16:9, 1:1, 4:5 or 21:9.

Available options:
9:16,
16:9,
1:1,
4:5,
21:9
duration

About how long: a bucket (<10s, 10-30s, 30s-1min, 1-5min) or whole seconds from 3 to 600. Omitted: the planner fits the brief (or the style reference).

Available options:
<10s,
10-30s,
30s-1min,
1-5min
templateId
enum<string>

A house video template to lock the look to (see video.options). Omitted: the brand kit default, else the planner picks.

Available options:
editorial-signal,
night-interface,
evidence-ledger,
footage-journal,
presenter-focus,
founder-editorial,
kinetic-impact
attachments
object[]

Up to 100 files or pages to use. Attaching a file confirms you may use it in this video.

Maximum array length: 100
review
enum<string>

auto (default): plan, then render at the quoted price. plan: stop at awaiting_user_input with the plan; approve or revise it with video_followup.

Available options:
auto,
plan
{key}
any

Response

Success.

success
boolean
required
quote
object
required
{key}
any