Skip to main content
GET
Get a single workflow template (full, with definition + sample_input)
The full template, including its definition and a sample_input you can run it with unchanged.

Authorizations

Authorization
string
header
required

API key in format: Bearer inf_***

Path Parameters

slug
string
required

Template slug, as returned in the list. Max 120 characters — a longer one is answered 404 without a lookup.

Example:

"weekly-report"

Response

The template. Carries either definition/sample_input/inputs, or unavailable — never both.

slug
string
required

Stable identifier, and the path segment for the detail route. Max 120 characters.

Example:

"weekly-report"

title
string
required

Display title. Max 200 characters.

Example:

"Weekly report"

description
string
required

Catalog description. Always a string — the column is NOT NULL.

Example:

"Summarise a week of notes and render a PDF."

category
string | null
required

Catalog category, or null when the template is uncategorised. The category filter matches this exactly.

Example:

"reporting"

tags
string[]
required

Free-form tags. The tag filter matches a template whose array CONTAINS the given tag.

Example:
step_types_used
string[]
required

The step types the template's definition uses, denormalised at seed time for filtering and display.

Example:
thumbnail_url
string | null
required

Preview image URL, or null when the template has none.

Example:

null

created_at
string
required

ISO-8601 creation timestamp. The list is ordered by this, OLDEST first.

Example:

"2026-02-11T08:00:00.000Z"

definition
object

The template's workflow definition, ready to send as the definition of a run. Unmodelled here — its shape is the Zod schema in schemas/pipeline-definition.schema.ts. Validated when the template was seeded, not on this read. Absent when unavailable is present.

sample_input
object

An example input object for this template. {} when the template declares none. Absent when unavailable is present.

inputs
object[]

The declared run inputs read out of definition.inputs. [] for a legacy template that predates the input contract. Absent when unavailable is present.

unavailable
object

Present only when the template is hidden. Its presence is what tells you definition was withheld deliberately rather than being missing.