API Referencev2 API (Current)Workflows

Update Workflow

Update workflow metadata.

Authentication

X-Browser-Use-API-Keystring
API Key authentication via header

Path Parameters

workflow_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
namestring or nullOptional1-200 characters
Name of the workflow
descriptionstring or nullOptional<=5000 characters
Description of the workflow
variablesmap from strings to any or nullOptional

Variables/parameters for the workflow

Response

Successful Response
idstringformat: "uuid"
Unique identifier for the workflow
projectIdstringformat: "uuid"
Project ID this workflow belongs to
namestring
Name of the workflow
createdAtdatetime
Naive UTC timestamp when the workflow was created
updatedAtdatetime
Naive UTC timestamp when the workflow was last updated
userIdstring or null
User ID who created the workflow
descriptionstring or null
Description of the workflow
s3Keystring or null
S3 key where the workflow YAML is stored
yamlDownloadUrlstring or null
Presigned URL to download the workflow YAML
variablesmap from strings to any or null

Variables/parameters for the workflow

coststring or nullformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"Defaults to 0
Total cost incurred by this workflow
isArchivedboolean or nullDefaults to false
Whether the workflow is archived
generationStatusenum or null
Status of workflow YAML generation
Allowed values:
generationErrorstring or null
Error message if generation failed
inputSchemalist of maps from strings to any or null

Input schema from workflow YAML defining required/optional variables

inputTemplatemap from strings to any or null

Pre-filled input template based on input_schema for easy execution

Errors