Skip to main content
POST
/
workflows
/
get
Get workflow
curl --request POST \
  --url https://api.kaizenautomation.com/workflows/get \
  --header 'Content-Type: application/json' \
  --data '{
  "workflowId": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "isAuthenticationRequired": true,
  "autoSaveEnabled": true,
  "timeoutMs": 3600000,
  "shouldPauseOnError": false,
  "shouldSelfHeal": true,
  "shouldSaveResultFile": false,
  "maxConcurrentSessions": 10,
  "webhookUrls": [
    "<string>"
  ],
  "blocks": [
    "<any>"
  ],
  "model": "gpt-4.1-mini-2025-04-14",
  "useProxy": false,
  "operatingSystem": "Windows",
  "fingerprintBrowser": "Safari",
  "useLoginDetection": true,
  "retryConfiguration": {
    "delay": 123,
    "retryCount": 2
  },
  "blockRetryCount": 3,
  "blockBackoffStrategy": "exponential",
  "isOptimizedForComputerVision": true,
  "tags": [
    {
      "id": "<string>",
      "text": "<string>",
      "tagHexColor": "<string>",
      "organizationId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

Body

application/json
workflowId
string
required

ID of the workflow to retrieve

Response

Workflow retrieved successfully

id
string
required

ID of the workflow

name
string
required

Name of the workflow

isAuthenticationRequired
boolean
required

Whether authentication is required for this workflow

autoSaveEnabled
boolean
required

Whether auto-save is enabled for this workflow

blocks
array
required

Blocks of the workflow

  • Login
  • Form Block
  • FillDocument
  • Mouse Block
  • Hover Block
  • Input
  • Date Input
  • Extract
  • ParseDocument
  • Extract from Input
  • QueryKnowledgeBase
  • API
  • Close Page
  • Close Popup
  • Multistep
  • Option 19
  • Network Request Block
  • Wait
  • WaitForCondition
  • Fail
  • Option 24
  • Option 25
  • Option 26
  • Option 27
  • Download File Block
  • Save As PDF Block
  • CodeV2
  • Transform
  • Parse to CSV
  • Exit From Loop
  • Loop
  • If
timeoutMs
integer | null

Timeout in milliseconds for workflow execution

Example:

3600000

shouldPauseOnError
boolean

Whether to pause workflow execution on error

Example:

false

shouldSelfHeal
boolean

Whether to automatically clean up cache when workflow execution fails

Example:

true

shouldSaveResultFile
boolean

Whether to save result files for this workflow

Example:

false

maxConcurrentSessions
integer | null

Maximum concurrent executions for this workflow

Required range: x > 0
Example:

10

webhookUrls
string<uri>[]

List of webhook URLs for this workflow

model

The LLM model used for this workflow

Available options:
gpt-4.1-mini-2025-04-14,
gpt-4.1-2025-04-14,
gpt-5-2025-08-07,
gpt-5-mini-2025-08-07,
gpt-5-nano-2025-08-07,
computer-use-preview
useProxy
boolean

Whether to use proxy for this workflow

Example:

false

operatingSystem
enum<string> | null

Operating system for browser sessions (defaults to no preference)

Available options:
Windows,
MacOS,
Linux
Example:

"Windows"

fingerprintBrowser
enum<string>

Browser fingerprint to use for sessions (defaults to Chrome)

Available options:
Chrome,
Safari
Example:

"Safari"

useLoginDetection
boolean

Whether to use login detection for this workflow

Example:

true

retryConfiguration
object | null

Retry configuration for failed blocks, or null if not configured

blockRetryCount
integer | null

Number of retries for failed blocks

Required range: x >= 0
Example:

3

blockBackoffStrategy
enum<string> | null

Backoff strategy for block retries

Available options:
exponential,
linear
Example:

"exponential"

isOptimizedForComputerVision
boolean

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

Example:

true

tags
object[]

List of tags associated with this workflow