Skip to main content
POST
Edit footage

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string

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

Required string length: 1 - 255

Body

application/json
projectId
string
required

Existing project that owns the source media and finished edit.

Required string length: 1 - 200
shootId
string
required

Stable id grouping the clips of one shoot.

Required string length: 1 - 120
clipIds
string[]
required

Storage ids of the source clips to edit.

Required array length: 1 - 200 elements
Minimum string length: 1
title
string
required

Title or editorial brief name.

Required string length: 1 - 200
brief
string

Optional editorial direction.

Maximum string length: 4000
makeLong
boolean
default:true

Produce a long-form cut.

shortsCount
integer
default:0

Number of short-form outputs to create; 0 means no shorts.

Required range: 0 <= x <= 10
longPlatform
string | null

Optional platform target for the long-form output, for example youtube or instagram.

shortsPlatform
string | null

Optional platform target for all short-form outputs.

shortTargetDurationSec
integer

Optional length of each short, in whole seconds (15-90). Omit to let the editor choose.

Required range: 15 <= x <= 90
compositionId
string

Optional saved composition in the project to lay the cut out on; send with compositionRevisionId.

Required string length: 1 - 200
compositionRevisionId
string

The composition revision the caller reviewed; a stale revision answers 409 conflict.

Required string length: 1 - 200
settings
object

Optional editor policy. Every field you omit takes the workspace's edit default (Settings, Edit defaults), else Sigmora's: captions and on-screen visuals on (founder-teleprompter vocabulary, standard density, figures fact-checked), standard cleanup, transcript-reading intelligence, cold open on, automatic pacing, subtle punch-in, no music bed. A field you send always wins, false included.

contentBrandId
string

Optional ContentBrand id used for packaging and metadata.

Required string length: 1 - 120
reviewCuts
boolean
default:false

When true, stop after the proposal for human or API approval; defaults false.

evidence
object[]

Optional evidence for document cards: up to 8 Library images (screenshots, documents), each with an optional caption of up to 120 characters.

Maximum array length: 8
schedulePack
object

Schedule the whole pack (the long cut and every finished short) on a YouTube channel automatically once every output has finished, on the pack cadence and through the workspace approval policy. What failed or was skipped is left out and the rest still goes out. Free; the edit is billed as usual. Never sets the AI-disclosure label.

callbackUrl
string<uri>

Public HTTPS URL for signed terminal job-event callbacks.

callbackSecret
string

At least 32 characters; verifies the signed callback envelope.

Required string length: 32 - 512
{key}
any

Response

Success.

success
boolean
required
projectId
string
required
parentJobId
string
childJobIds
string[]
credits
number
creditBalance
number
{key}
any