Skip to main content
POST
Start stored recipe

Authorizations

Authorization
string
header
required

A workspace API key.

Path Parameters

recipeId
string
required

Opaque workflow recipe id.

Required string length: 1 - 200

Body

application/json
recipeId
string

The ready-made recipe to run it as; omitted, the first it allows that can start here.

Required string length: 1 - 200
inputs
object

The recipe’s answers, as GET /v1/recipes/capabilities lists them.

settings
object

Its settings, as PATCH /v1/recipes/{recipeInstanceId} takes them.

{key}
any

Response

Success.

success
boolean
required
recipe
object
required
created
boolean
{key}
any