Skip to main content

How to write the YAML authoring spec

GET 
/v1/workflows/authoring-guide

Return the workflow authoring specification — the reference for the YAML spec format that POST /v1/workflows accepts.

It documents the spec's structure, how nodes and connections are declared, how {{alias.field}} variables reference upstream output, and the conventions the compiler enforces. It is kept in sync with the compiler itself, so it always describes what the current backend will accept rather than a snapshot of the docs.

Fetch it once and cache it. Requires the workflows:read scope.

Responses​

Successful Response

Last updated on