Skip to main content
GET
One recipe

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Request-Id
string

Your own id for this request — 8 to 128 letters, digits, ., _, : or -. Used in place of one we mint, and echoed back.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$

Path Parameters

ref
string
required

A ready-made slug, your recipe's id, or a shared recipe's public slug.

Examples:

"podcast-to-clips"

"tiktok-ready"

Response

The recipe.

A named sequence of steps. takes, makes, credits and problems are worked out from the steps, with the same rules the Workbench and the runner use.

origin
enum<string>
required
Available options:
catalogue,
mine,
community
ref
string
required

What recipe takes on POST /api/v1/runs.

name
string
required
steps
object[]
required
takes
enum<string>[]
required
Available options:
image,
video,
audio,
document
makes
enum<string>[]
required
Available options:
image,
video,
audio,
document
inputs
object[]
required

What a run has to be told: the {{names}} its steps use. Send them as inputs on POST /api/v1/runs. Empty when it asks for nothing.

problems
string[]
required

Why a step can't sit where it is. A recipe with any is refused when run.

slug
string | null
id
string<uuid>
tagline
string | null
caveat
string | null
skills
string[]
credits
object

For one file of one minute: what grows with its length, and what doesn't.

paid_only
boolean
shared_at
string<date-time> | null
updated_at
string<date-time>
version
integer

A saved or shared recipe's version: the one these steps are. A new version is made each time its steps change.

author
string
run
object