Sign in
Workflows

Create a new workflow

Creates a new workflow for the authenticated organization

post/workflows/create

Request body

namestring required

Name of the workflow to create

isAuthenticationRequiredboolean

Whether authentication is required for this workflow (defaults to false)

useProxyboolean

Whether to use proxy for this workflow (defaults to false)

operatingSystem'Windows' | 'MacOS' | 'Linux' nullable

Operating system for browser sessions

fingerprintBrowser'Chrome' | 'Safari'

Browser fingerprint to use for sessions

isOptimizedForComputerVisionboolean

Whether this workflow is optimized for computer vision blocks (uses specialized viewport and settings, defaults to true)

timeoutMsinteger

Timeout in milliseconds for workflow execution (defaults to 10800000ms / 3 hours)

Example request

{
  "name": "My New Workflow",
  "blocks": [
    {
      "name": "navigate",
      "type": "Navigate",
      "blockReferenceId": "block_ref_example_123",
      "data": {
        "actionType": "GoTo",
        "url": "https://example.com"
      },
      "isCacheable": false,
      "skipIfNotPresent": false,
      "useWorkflowRecoveryAgent": false
    }
  ],
  "operatingSystem": "Windows",
  "fingerprintBrowser": "Safari",
  "isOptimizedForComputerVision": true,
  "timeoutMs": 10800000
}

Response

Workflow created successfully

idstring required

ID of the workflow

namestring required

Name of the workflow

isAuthenticationRequiredboolean required

Whether authentication is required for this workflow

autoSaveEnabledboolean required

Whether auto-save is enabled for this workflow

timeoutMsinteger nullable

Timeout in milliseconds for workflow execution

shouldPauseOnErrorboolean

Whether to pause workflow execution on error

shouldSelfHealboolean

Whether to automatically clean up cache when workflow execution fails

shouldSaveResultFileboolean

Whether to save result files for this workflow

maxConcurrentSessionsinteger nullable

Maximum concurrent executions for this workflow

useProxyboolean

Whether to use proxy for this workflow

operatingSystem'Windows' | 'MacOS' | 'Linux' nullable

Operating system for browser sessions (defaults to no preference)

knowledgeBasestring

Knowledge base text for this workflow

useLoginDetectionboolean

Whether to use login detection for this workflow

blockRetryCountinteger nullable

Number of retries for failed blocks

blockBackoffStrategy'exponential' | 'linear' nullable

Backoff strategy for block retries

isOptimizedForComputerVisionboolean

Whether this workflow is optimized for computer vision blocks (uses specialized viewport and settings)

waitBetweenBlocksMsinteger

Wait time in milliseconds between executing each block

workflowGroupIdstring nullable

ID of the workflow group this workflow belongs to

useRecoveryAgentboolean

Whether to enable the recovery agent for all blocks in this workflow. When enabled, all blocks will use the recovery agent regardless of their individual settings.

executionMode'standard' | 'structured'

Execution mode for this workflow. "standard" is the default, "structured" is experimental visual mode.

executeInAgentModeboolean

Whether this workflow should execute in agent mode instead of traditional block-based execution.

agentModeKaizenVersion'Full' | 'Lite' | 'Open' | 'Flash' | 'Fast' | 'Amethyst' nullable required

Kaizen mode used when this workflow executes in agent mode. Null uses the organization default.

agentModeSummarySchemaobject nullable

JSON Schema that defines the structure of the execution summary when running in agent mode.

Changes