sdkDeterministic

Update workflow

pipeline.updateWorkflow

Update an existing workflow. Pass any subset of name, description, workflow_definition, or status. workflow_definition is the full DAG object (nodes + edges + variables) - typically produced by compile-workflow-from-prompt. Returns the updated workflow record.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

workflowIdrequired

string

Workflow UUID to update.

name

string

No description.

description

string

No description.

workflow_definition

object

Full WorkflowDefinition DAG. Typically supplied verbatim from the compile-workflow-from-prompt response.

status

string

Optional status transition.

draft | active | paused | archived

Example

TypeScripttypescript

await pipeline.updateWorkflow({
  "workflowId": "00000000-0000-4000-8000-000000000000"
})

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.