Workflows v2 (Plays) / CLI

Create workflow

Create a new empty workflow shell in the workspace. Returns the freshly-minted workflow with an empty workflow_definition that you then populate via update-workflow (or by routing through compile-workflow-from-prompt). For prompt-driven creation, prefer compile-workflow-from-prompt followed by create-workflow + update-workflow.

pipeline create-workflowDeterministic operation

Parameters

workspaceIdOptional · string: Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
nameRequired · string: Human-friendly workflow name.
descriptionOptional · string: Optional one-liner describing what the workflow does.
workspace_idOptional · string: Workspace UUID. Optional with API key auth - inferred from the key.

Request example

pipeline create-workflow \
  --name "example"

Full input schema

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "minLength": 1,
      "description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
    },
    "name": {
      "type": "string",
      "description": "Human-friendly workflow name."
    },
    "description": {
      "type": "string",
      "description": "Optional one-liner describing what the workflow does."
    },
    "workspace_id": {
      "type": "string",
      "description": "Workspace UUID. Optional with API key auth - inferred from the key."
    }
  },
  "required": [
    "name"
  ]
}

See this operation inMCP REST API TypeScript SDK