sdkDeterministic

Create workflow

pipeline.createWorkflow

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.

Parameters

workspaceId

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.

description

string

Optional one-liner describing what the workflow does.

workspace_id

string

Workspace UUID. Optional with API key auth - inferred from the key.

Example

TypeScripttypescript

await pipeline.createWorkflow({
  "name": "example"
})

Response

The operation is available, but its typed response schema has not been published yet.

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.