Create Workflow

Request body

namestring nullable

The name for a new workflow. If not provided, a name will be auto-generated.

workflow_idinteger nullable

The ID of an existing workflow to create a new version for.

workflow_namestring nullable

The name of an existing workflow to create a new version for.

folder_idinteger nullable

The folder ID to place the workflow in.

commit_messagestring nullable

A message describing the changes in this version.

required_input_variablesobject

A mapping of variable names to their types.

release_labelsstring[] nullable

Labels to attach to this version.

Example request

{
  "nodes": [
    {
      "name": "greeting",
      "node_type": "VARIABLE",
      "is_output_node": true,
      "configuration": {
        "value": {
          "type": "string",
          "value": "Hello, World!"
        }
      },
      "dependencies": []
    }
  ]
}

Response

Workflow created successfully

successboolean required

Indicates if the request was successful.

workflow_idinteger required

The ID of the workflow.

workflow_namestring required

The name of the workflow.

workflow_version_idinteger required

The ID of the created workflow version.

version_numberinteger required

The version number.

base_versioninteger nullable

The base version this was created from (PATCH only).