WorkflowClient.update

def WorkflowClient.update(
    workflow_or_slug: Workflow | str,
    name: str | None = None,
    description: str | None = None,
) -> Workflow

Copy

Update a workflow.

Parameters

workflow_or_slug Workflow | str required

The workflow or workflow slug to update.

name str | None

Optional new display name for the workflow. If omitted, the display name is unchanged.

description str | None

Optional new workflow description. Pass an empty string to clear the description. If omitted, the description is unchanged.

Returns

The updated workflow object.

Request example

Python

workflow = workflow_client.update(
    "scene-processing",
    name="Scene processing",
    description="Process new scenes into analysis-ready outputs.",
)

Copy