Skip to main content
POST
Run recipe now

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

recipeInstanceId
string
required

A started recipe (ri_...), as Workflows > Recipes and its run records name it.

Required string length: 1 - 200

Body

application/json
projectId
string
required

Project the run files its work in: a clips recipe’s own project (its run records link it), or any project for a channel render.

Required string length: 1 - 200
item
object

Response

Success.

success
boolean
required
quote
object
required
{key}
any