POST
/
workflows
/
{workflow_id}
/
definition
{
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "<string>",
  "version": 123,
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": {}
}

Authorizations

​
fastapiusersauth
string
cookie
required

Path Parameters

​
workflow_id
required

Query Parameters

​
workspace_id
string
required

Response

200
application/json
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
required
​
version
integer
required

DSL spec version

​
workflow_id
string
required
​
content
object
required
​
created_at
string
​
updated_at
string
​
id
string

Was this page helpful?

Get Workflow Definition
Previous
List Tags
Next