Skip to main content
POST
Add recipe revision

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string
required

Required stable id for this logical write; reuse it after a timeout. Upload endpoints also require the same value in body.idempotencyKey.

Required string length: 1 - 255

Path Parameters

recipeId
string
required

Opaque workflow recipe id.

Required string length: 1 - 200

Body

application/json
definition
object
required

Replacement immutable behavior for the newly appended revision.

title
string

Optional replacement human-readable recipe name.

Required string length: 1 - 240
description
string

Optional replacement summary of purpose and operating constraints.

Required string length: 1 - 4000
status
enum<string>

Initial lifecycle state for the appended revision; omit for draft.

Available options:
draft,
approved,
archived

Response

Success.

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