Skip to main content
GET
/
workflows
/
{workflow_id}
/
definition
Get Workflow Definition
curl --request GET \
  --url https://api.example.com/workflows/{workflow_id}/definition \
  --cookie fastapiusersauth=
{
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version": 123,
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": "<string>"
}

Authorizations

​
fastapiusersauth
string
cookie
required

Path Parameters

​
workflow_id
required
Pattern: wf_[0-9a-zA-Z]+

Query Parameters

​
version
integer | null
​
workspace_id
string<uuid>
required

Response

Successful Response

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<uuid>
required
​
version
integer
required

DSL spec version

​
workflow_id
string<uuid>
required
​
content
Content · object
required
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
id
string