GET
/
workflows
/
{workflow_id}
/
definition

Authorizations

​
fastapiusersauth
string
cookierequired

Path Parameters

​
workflow_id
string
required

Query Parameters

​
version
integer | null
​
workspace_id
string
required

Response

200 - application/json

A workflow definition.

This is the underlying representation/snapshot of a workflow in the system, which can directly execute in the runner.

Shoulds

  1. Be convertible into a Workspace Workflow + Acitons
  2. Be convertible into a YAML DSL
  3. Be able to be versioned

Shouldn'ts

  1. Have any stateful information

Relationships

  • 1 Workflow to many WorkflowDefinitions
​
owner_id
string
required
​
created_at
string
required
​
updated_at
string
required
​
version
integer
required

DSL spec version

​
workflow_id
string
required
​
content
object
required
​
id
string
Export WorkflowCreate Workflow Definition