Skip to main content
POST
Batch edit

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+$

Body

application/json
clipIds
string[]
required

Library content ids; each becomes its own output (at most 50).

Required array length: 1 - 50 elements
Pattern: ^[A-Za-z0-9._-]{1,256}$
projectId
string
required

Existing project the output is filed in (POST /v1/projects).

Required string length: 1 - 200
recipe
object

The look and the edits applied to every clip; omitted takes the Quick defaults.

name
string

A name for the batch, up to 120 characters; omitted: "Batch of N".

Maximum string length: 120
quoteOnly
boolean

Price the batch and start nothing.

maxCredits
integer

Refuse, starting nothing, if the batch costs more (the same cap as X-Sigmora-Max-Credits).

Required range: 0 <= x <= 9007199254740991

Response

Success.

success
boolean
required
projectId
string
created
boolean
batch
object
counts
object
quote
object
{key}
any