TabGeckoPUT
/api/v1/automation/workflows/{id}
Update an RPA workflow
Request#
POSIX shell · curl
curl --fail-with-body --request PUT \
"$ADBR_API_URL/api/v1/automation/workflows/{id}" \
-H "Authorization: Bearer $ADBR_API_TOKEN" \
-H "Content-Type: application/json" \
--data @request.jsonUse the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.
Authentication and permissions#
Authentication: Bearer token
Scopes: runtime:control, rpa:write
All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.
Parameters#
| Parameter | Location | Required | Description |
|---|---|---|---|
operation_id | query | No | |
id | path | Yes |
Complete parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9-]{16,64}$"
},
"in": "query",
"name": "operation_id",
"required": false
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body#
Required.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | |
group | string | No | |
description | string | No | |
is_template | boolean | No | |
steps | array | Yes | |
profile_ids | array | Yes | |
concurrency | integer | Yes | |
priority | union | No | |
close_after | boolean | Yes | |
headless | boolean | No | |
browser | object | No | |
delay_ms | integer | Yes | |
input_timing | object | No | |
schedule | union | Yes |
Complete body schema
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"steps",
"profile_ids",
"concurrency",
"close_after",
"delay_ms",
"schedule"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"group": {
"type": "string",
"maxLength": 80
},
"description": {
"type": "string",
"maxLength": 2000
},
"is_template": {
"type": "boolean"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"action"
],
"properties": {
"node_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"next_step": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
{
"type": "null"
}
]
},
"else_step": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
{
"type": "null"
}
]
},
"route_when": {
"type": "object",
"required": [
"variable",
"operator"
],
"properties": {
"variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"operator": {
"anyOf": [
{
"type": "string",
"enum": [
"exists"
]
},
{
"type": "string",
"enum": [
"not_exists"
]
},
{
"type": "string",
"enum": [
"equals"
]
},
{
"type": "string",
"enum": [
"not_equals"
]
},
{
"type": "string",
"enum": [
"contains"
]
},
{
"type": "string",
"enum": [
"not_contains"
]
},
{
"type": "string",
"enum": [
"starts_with"
]
},
{
"type": "string",
"enum": [
"ends_with"
]
},
{
"type": "string",
"enum": [
"less"
]
},
{
"type": "string",
"enum": [
"less_equal"
]
},
{
"type": "string",
"enum": [
"greater"
]
},
{
"type": "string",
"enum": [
"greater_equal"
]
},
{
"type": "string",
"enum": [
"one_of"
]
},
{
"type": "string",
"enum": [
"not_one_of"
]
}
]
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"number"
]
}
]
}
},
"additionalProperties": false
},
"route_value": {
"type": "string",
"maxLength": 10000
},
"input_format": {
"anyOf": [
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"html"
]
}
]
},
"editable_selection": {
"type": "object",
"required": [
"anchor",
"focus"
],
"properties": {
"anchor": {
"type": "object",
"required": [
"path",
"offset",
"text"
],
"properties": {
"path": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"maxItems": 64
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"text": {
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
"additionalProperties": false
},
"focus": {
"type": "object",
"required": [
"path",
"offset",
"text"
],
"properties": {
"path": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"maxItems": 64
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"text": {
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"editor": {
"anyOf": [
{
"type": "string",
"enum": [
"codemirror5"
]
},
{
"type": "string",
"enum": [
"codemirror6"
]
},
{
"type": "string",
"enum": [
"monaco"
]
},
{
"type": "string",
"enum": [
"ace"
]
},
{
"type": "string",
"enum": [
"quill"
]
},
{
"type": "string",
"enum": [
"tinymce"
]
}
]
},
"editor_selections": {
"type": "array",
"items": {
"type": "object",
"required": [
"anchor",
"head"
],
"properties": {
"anchor": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"head": {
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 100
},
"editor_primary": {
"type": "integer",
"minimum": 0,
"maximum": 99
},
"selection_only": {
"type": "boolean"
},
"input_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"append"
]
},
{
"type": "string",
"enum": [
"replace"
]
}
]
},
"text_selection": {
"type": "object",
"required": [
"start",
"end",
"direction"
],
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"direction": {
"anyOf": [
{
"type": "string",
"enum": [
"forward"
]
},
{
"type": "string",
"enum": [
"backward"
]
},
{
"type": "string",
"enum": [
"none"
]
}
]
}
},
"additionalProperties": false
},
"navigation_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"always"
]
},
{
"type": "string",
"enum": [
"if_needed"
]
}
]
},
"scroll_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"relative"
]
},
{
"type": "string",
"enum": [
"absolute"
]
}
]
},
"tab_reuse": {
"type": "boolean"
},
"breakpoint": {
"type": "boolean"
},
"position": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 10000
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 200000
}
},
"additionalProperties": false
},
"action": {
"anyOf": [
{
"type": "string",
"enum": [
"navigate"
]
},
{
"type": "string",
"enum": [
"click"
]
},
{
"type": "string",
"enum": [
"drag"
]
},
{
"type": "string",
"enum": [
"upload"
]
},
{
"type": "string",
"enum": [
"dialog"
]
},
{
"type": "string",
"enum": [
"type"
]
},
{
"type": "string",
"enum": [
"key"
]
},
{
"type": "string",
"enum": [
"wait"
]
},
{
"type": "string",
"enum": [
"manual_wait"
]
},
{
"type": "string",
"enum": [
"wait_selector"
]
},
{
"type": "string",
"enum": [
"extract"
]
},
{
"type": "string",
"enum": [
"page_data"
]
},
{
"type": "string",
"enum": [
"tab_open"
]
},
{
"type": "string",
"enum": [
"tab_switch"
]
},
{
"type": "string",
"enum": [
"tab_close"
]
},
{
"type": "string",
"enum": [
"frame_enter"
]
},
{
"type": "string",
"enum": [
"frame_parent"
]
},
{
"type": "string",
"enum": [
"frame_top"
]
},
{
"type": "string",
"enum": [
"reload"
]
},
{
"type": "string",
"enum": [
"hover"
]
},
{
"type": "string",
"enum": [
"double_click"
]
},
{
"type": "string",
"enum": [
"right_click"
]
},
{
"type": "string",
"enum": [
"scroll"
]
},
{
"type": "string",
"enum": [
"select"
]
},
{
"type": "string",
"enum": [
"attribute"
]
},
{
"type": "string",
"enum": [
"screenshot"
]
},
{
"type": "string",
"enum": [
"cookies_get"
]
},
{
"type": "string",
"enum": [
"cookies_set"
]
},
{
"type": "string",
"enum": [
"cookies_delete"
]
},
{
"type": "string",
"enum": [
"focus"
]
},
{
"type": "string",
"enum": [
"exists"
]
},
{
"type": "string",
"enum": [
"attribute_set"
]
},
{
"type": "string",
"enum": [
"mouse_move"
]
},
{
"type": "string",
"enum": [
"wheel"
]
},
{
"type": "string",
"enum": [
"history_back"
]
},
{
"type": "string",
"enum": [
"history_forward"
]
},
{
"type": "string",
"enum": [
"tab_list"
]
},
{
"type": "string",
"enum": [
"tab_activate"
]
},
{
"type": "string",
"enum": [
"script"
]
},
{
"type": "string",
"enum": [
"workflow_call"
]
},
{
"type": "string",
"enum": [
"branch"
]
},
{
"type": "string",
"enum": [
"loop_count"
]
},
{
"type": "string",
"enum": [
"loop_data"
]
},
{
"type": "string",
"enum": [
"loop_elements"
]
},
{
"type": "string",
"enum": [
"element_capture"
]
},
{
"type": "string",
"enum": [
"element_release"
]
},
{
"type": "string",
"enum": [
"loop_while"
]
},
{
"type": "string",
"enum": [
"loop_break"
]
},
{
"type": "string",
"enum": [
"loop_continue"
]
},
{
"type": "string",
"enum": [
"variable_set"
]
},
{
"type": "string",
"enum": [
"global"
]
},
{
"type": "string",
"enum": [
"data_transform"
]
},
{
"type": "string",
"enum": [
"file"
]
},
{
"type": "string",
"enum": [
"service"
]
},
{
"type": "string",
"enum": [
"network"
]
}
]
},
"data": {
"type": "object",
"required": [
"operation"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"csv_parse"
]
},
{
"type": "string",
"enum": [
"csv_stringify"
]
},
{
"type": "string",
"enum": [
"table_cell"
]
},
{
"type": "string",
"enum": [
"table_set"
]
},
{
"type": "string",
"enum": [
"table_row"
]
},
{
"type": "string",
"enum": [
"table_column"
]
},
{
"type": "string",
"enum": [
"table_append"
]
},
{
"type": "string",
"enum": [
"table_slice"
]
},
{
"type": "string",
"enum": [
"json_parse"
]
},
{
"type": "string",
"enum": [
"json_get"
]
},
{
"type": "string",
"enum": [
"json_keys"
]
},
{
"type": "string",
"enum": [
"list_length"
]
},
{
"type": "string",
"enum": [
"list_join"
]
},
{
"type": "string",
"enum": [
"list_append"
]
},
{
"type": "string",
"enum": [
"list_random"
]
},
{
"type": "string",
"enum": [
"text_split"
]
},
{
"type": "string",
"enum": [
"text_replace"
]
},
{
"type": "string",
"enum": [
"regex_extract"
]
},
{
"type": "string",
"enum": [
"regex_replace"
]
},
{
"type": "string",
"enum": [
"text_trim"
]
},
{
"type": "string",
"enum": [
"text_lower"
]
},
{
"type": "string",
"enum": [
"text_upper"
]
},
{
"type": "string",
"enum": [
"number_add"
]
},
{
"type": "string",
"enum": [
"number_subtract"
]
},
{
"type": "string",
"enum": [
"number_multiply"
]
},
{
"type": "string",
"enum": [
"number_divide"
]
},
{
"type": "string",
"enum": [
"number_remainder"
]
},
{
"type": "string",
"enum": [
"url_parse"
]
},
{
"type": "string",
"enum": [
"url_parameter"
]
},
{
"type": "string",
"enum": [
"random_integer"
]
},
{
"type": "string",
"enum": [
"random_text"
]
}
]
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
}
},
"additionalProperties": false
},
"global": {
"type": "object",
"required": [
"operation",
"name"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"read"
]
},
{
"type": "string",
"enum": [
"write"
]
},
{
"type": "string",
"enum": [
"delete"
]
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"expected_revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"additionalProperties": false
},
"page_data": {
"anyOf": [
{
"type": "string",
"enum": [
"url"
]
},
{
"type": "string",
"enum": [
"title"
]
},
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"html"
]
},
{
"type": "string",
"enum": [
"links"
]
},
{
"type": "string",
"enum": [
"images"
]
},
{
"type": "string",
"enum": [
"form_values"
]
},
{
"type": "string",
"enum": [
"element_count"
]
}
]
},
"file": {
"type": "object",
"required": [
"operation",
"format",
"name"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"read"
]
},
{
"type": "string",
"enum": [
"write"
]
},
{
"type": "string",
"enum": [
"append"
]
}
]
},
"format": {
"anyOf": [
{
"type": "string",
"enum": [
"txt"
]
},
{
"type": "string",
"enum": [
"json"
]
},
{
"type": "string",
"enum": [
"csv"
]
},
{
"type": "string",
"enum": [
"xlsx"
]
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"delimiter": {
"anyOf": [
{
"type": "string",
"enum": [
","
]
},
{
"type": "string",
"enum": [
";"
]
},
{
"type": "string",
"enum": [
"\t"
]
},
{
"type": "string",
"enum": [
"|"
]
}
]
},
"sheet": {
"type": "string",
"minLength": 1,
"maxLength": 31
},
"overwrite": {
"type": "boolean"
}
},
"additionalProperties": false
},
"service": {
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"http"
]
},
{
"type": "string",
"enum": [
"google_sheets"
]
},
{
"type": "string",
"enum": [
"otp"
]
}
]
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
}
},
"additionalProperties": false
},
"network": {
"type": "object",
"required": [
"operation"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"start"
]
},
{
"type": "string",
"enum": [
"read"
]
},
{
"type": "string",
"enum": [
"stop"
]
}
]
},
"url_contains": {
"type": "string",
"maxLength": 2000
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"all"
]
},
{
"type": "string",
"enum": [
"request"
]
},
{
"type": "string",
"enum": [
"response"
]
},
{
"type": "string",
"enum": [
"error"
]
}
]
},
"include_headers": {
"type": "boolean"
},
"include_bodies": {
"type": "boolean"
},
"max_events": {
"type": "integer",
"minimum": 1,
"maximum": 1000
}
},
"additionalProperties": false
},
"selector": {
"type": "string",
"maxLength": 2000
},
"element_ref": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"workflow_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"else_workflow_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"predicate": {
"type": "object",
"required": [
"variable",
"operator"
],
"properties": {
"variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"operator": {
"anyOf": [
{
"type": "string",
"enum": [
"exists"
]
},
{
"type": "string",
"enum": [
"not_exists"
]
},
{
"type": "string",
"enum": [
"equals"
]
},
{
"type": "string",
"enum": [
"not_equals"
]
},
{
"type": "string",
"enum": [
"contains"
]
},
{
"type": "string",
"enum": [
"not_contains"
]
},
{
"type": "string",
"enum": [
"starts_with"
]
},
{
"type": "string",
"enum": [
"ends_with"
]
},
{
"type": "string",
"enum": [
"less"
]
},
{
"type": "string",
"enum": [
"less_equal"
]
},
{
"type": "string",
"enum": [
"greater"
]
},
{
"type": "string",
"enum": [
"greater_equal"
]
},
{
"type": "string",
"enum": [
"one_of"
]
},
{
"type": "string",
"enum": [
"not_one_of"
]
}
]
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"number"
]
}
]
}
},
"additionalProperties": false
},
"data_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"item_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"index_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"loop_start": {
"type": "integer",
"minimum": 0,
"maximum": 9999
},
"max_iterations": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"script_variables": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"maxItems": 64,
"uniqueItems": true
},
"element_index": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"element_random_min": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"element_random_max": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"tab_match": {
"anyOf": [
{
"type": "string",
"enum": [
"id"
]
},
{
"type": "string",
"enum": [
"url"
]
},
{
"type": "string",
"enum": [
"title"
]
},
{
"type": "string",
"enum": [
"next"
]
},
{
"type": "string",
"enum": [
"previous"
]
},
{
"type": "string",
"enum": [
"index"
]
}
]
},
"tab_compare": {
"anyOf": [
{
"type": "string",
"enum": [
"equals"
]
},
{
"type": "string",
"enum": [
"not_equals"
]
},
{
"type": "string",
"enum": [
"contains"
]
},
{
"type": "string",
"enum": [
"not_contains"
]
},
{
"type": "string",
"enum": [
"starts_with"
]
},
{
"type": "string",
"enum": [
"ends_with"
]
}
]
},
"tab_wrap": {
"type": "boolean"
},
"scroll_x": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"scroll_y": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"full_page": {
"type": "boolean"
},
"screenshot_format": {
"anyOf": [
{
"type": "string",
"enum": [
"png"
]
},
{
"type": "string",
"enum": [
"jpeg"
]
}
]
},
"screenshot_frame_content": {
"type": "boolean"
},
"screenshot_output": {
"anyOf": [
{
"type": "string",
"enum": [
"file"
]
},
{
"type": "string",
"enum": [
"base64"
]
}
]
},
"screenshot_quality": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"screenshot_name": {
"type": "string",
"maxLength": 100
},
"dialog": {
"type": "object",
"required": [
"type",
"accept"
],
"properties": {
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"alert"
]
},
{
"type": "string",
"enum": [
"confirm"
]
},
{
"type": "string",
"enum": [
"prompt"
]
},
{
"type": "string",
"enum": [
"beforeunload"
]
}
]
},
"accept": {
"type": "boolean"
},
"message": {
"type": "string",
"maxLength": 4000
}
},
"additionalProperties": false
},
"drag": {
"type": "object",
"required": [
"path"
],
"properties": {
"target": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"target_tab": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"target_frames": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"maxItems": 16
},
"coordinate_space": {
"type": "string",
"enum": [
"top"
]
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"additionalProperties": false
},
"path": {
"type": "array",
"items": {
"type": "object",
"required": [
"x",
"y",
"t"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"t": {
"type": "integer",
"minimum": 0,
"maximum": 30000
},
"tab": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"scroll": {
"type": "array",
"items": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"selector": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"frames": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"maxItems": 16
},
"x": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"y": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
}
},
"additionalProperties": false
},
"maxItems": 32
}
},
"additionalProperties": false
},
"minItems": 2,
"maxItems": 256
}
},
"additionalProperties": false
},
"file_chooser": {
"anyOf": [
{
"type": "string",
"enum": [
"select"
]
},
{
"type": "string",
"enum": [
"cancel"
]
}
]
},
"uploads": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"size",
"sha256"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9-]{36}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"size": {
"type": "integer",
"minimum": 0,
"maximum": 104857600
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"last_modified": {
"type": "integer",
"minimum": 0,
"maximum": 8640000000000000
}
},
"additionalProperties": false
},
"maxItems": 100
},
"selection": {
"type": "array",
"items": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"maxLength": 10000
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
"additionalProperties": false
},
"maxItems": 1000
},
"pointer_offset": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"additionalProperties": false
},
"pointer_x": {
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"pointer_y": {
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"wait_ms": {
"type": "integer",
"minimum": 0,
"maximum": 119000
},
"attribute_name": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"secret_value": {
"type": "boolean"
},
"value_missing": {
"type": "boolean"
},
"cookie_domain": {
"type": "string",
"maxLength": 253
},
"cookie_name": {
"type": "string",
"maxLength": 1024
},
"cookie_path": {
"type": "string",
"maxLength": 2048
},
"cookie_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"merge"
]
},
{
"type": "string",
"enum": [
"replace"
]
}
]
},
"cookie_output": {
"anyOf": [
{
"type": "string",
"enum": [
"json"
]
},
{
"type": "string",
"enum": [
"netscape"
]
},
{
"type": "string",
"enum": [
"header"
]
},
{
"type": "string",
"enum": [
"value"
]
}
]
},
"value": {
"type": "string",
"maxLength": 10000
},
"save_as": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"repeat": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"retries": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"timeout_ms": {
"type": "integer",
"minimum": 100,
"maximum": 120000
},
"on_error": {
"anyOf": [
{
"type": "string",
"enum": [
"stop"
]
},
{
"type": "string",
"enum": [
"continue"
]
}
]
},
"condition": {
"type": "object",
"required": [
"variable",
"equals"
],
"properties": {
"variable": {
"type": "string",
"maxLength": 64
},
"equals": {
"type": "string",
"maxLength": 10000
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 200
},
"profile_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 500,
"uniqueItems": true
},
"concurrency": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"priority": {
"anyOf": [
{
"type": "string",
"enum": [
"low"
]
},
{
"type": "string",
"enum": [
"normal"
]
},
{
"type": "string",
"enum": [
"high"
]
}
]
},
"close_after": {
"type": "boolean"
},
"headless": {
"type": "boolean"
},
"browser": {
"type": "object",
"required": [
"provider",
"session_ttl"
],
"properties": {
"provider": {
"type": "string",
"enum": [
"zenrows"
]
},
"persist_cookies": {
"type": "boolean"
},
"persist_tabs": {
"type": "boolean"
},
"persist_local_storage": {
"type": "boolean"
},
"persist_indexed_db": {
"type": "boolean"
},
"persist_history": {
"type": "boolean"
},
"session_ttl": {
"type": "integer",
"minimum": 60,
"maximum": 900
},
"proxy_country": {
"type": "string",
"pattern": "^[a-z]{2}$"
}
},
"additionalProperties": false
},
"delay_ms": {
"type": "integer",
"minimum": 0,
"maximum": 30000
},
"input_timing": {
"type": "object",
"required": [
"key_min_ms",
"key_max_ms",
"step_jitter_ms"
],
"properties": {
"key_min_ms": {
"type": "integer",
"minimum": 0,
"maximum": 2000
},
"key_max_ms": {
"type": "integer",
"minimum": 0,
"maximum": 2000
},
"step_jitter_ms": {
"type": "integer",
"minimum": 0,
"maximum": 30000
},
"mouse_min_ms": {
"type": "integer",
"minimum": 0,
"maximum": 5000
},
"mouse_max_ms": {
"type": "integer",
"minimum": 0,
"maximum": 5000
}
},
"additionalProperties": false
},
"schedule": {
"anyOf": [
{
"type": "object",
"required": [
"next_at",
"interval_minutes"
],
"properties": {
"next_at": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799999
},
"interval_minutes": {
"type": "integer",
"minimum": 0,
"maximum": 525600
},
"time_zone": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"remaining_runs": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"end_at": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799999
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"calendar": {
"type": "object",
"required": [
"frequency",
"start_date",
"time"
],
"properties": {
"frequency": {
"anyOf": [
{
"type": "string",
"enum": [
"daily"
]
},
{
"type": "string",
"enum": [
"weekly"
]
},
{
"type": "string",
"enum": [
"monthly"
]
},
{
"type": "string",
"enum": [
"yearly"
]
}
]
},
"start_date": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"time": {
"type": "string",
"pattern": "^[0-9]{2}:[0-9]{2}$"
},
"weekdays": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 7
},
"minItems": 1,
"maxItems": 7,
"uniqueItems": true
},
"month": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"month_day": {
"anyOf": [
{
"type": "number",
"enum": [
-1
]
},
{
"type": "integer",
"minimum": 1,
"maximum": 31
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
}
}
}Responses#
200 · Default response
OpenAPI JSON
{
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"steps",
"profile_ids",
"concurrency",
"close_after",
"delay_ms",
"schedule",
"id"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"group": {
"type": "string",
"maxLength": 80
},
"description": {
"type": "string",
"maxLength": 2000
},
"is_template": {
"type": "boolean"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"action"
],
"properties": {
"node_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"next_step": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
{
"type": "null"
}
]
},
"else_step": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
{
"type": "null"
}
]
},
"route_when": {
"type": "object",
"required": [
"variable",
"operator"
],
"properties": {
"variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"operator": {
"anyOf": [
{
"type": "string",
"enum": [
"exists"
]
},
{
"type": "string",
"enum": [
"not_exists"
]
},
{
"type": "string",
"enum": [
"equals"
]
},
{
"type": "string",
"enum": [
"not_equals"
]
},
{
"type": "string",
"enum": [
"contains"
]
},
{
"type": "string",
"enum": [
"not_contains"
]
},
{
"type": "string",
"enum": [
"starts_with"
]
},
{
"type": "string",
"enum": [
"ends_with"
]
},
{
"type": "string",
"enum": [
"less"
]
},
{
"type": "string",
"enum": [
"less_equal"
]
},
{
"type": "string",
"enum": [
"greater"
]
},
{
"type": "string",
"enum": [
"greater_equal"
]
},
{
"type": "string",
"enum": [
"one_of"
]
},
{
"type": "string",
"enum": [
"not_one_of"
]
}
]
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"number"
]
}
]
}
},
"additionalProperties": false
},
"route_value": {
"type": "string",
"maxLength": 10000
},
"input_format": {
"anyOf": [
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"html"
]
}
]
},
"editable_selection": {
"type": "object",
"required": [
"anchor",
"focus"
],
"properties": {
"anchor": {
"type": "object",
"required": [
"path",
"offset",
"text"
],
"properties": {
"path": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"maxItems": 64
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"text": {
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
"additionalProperties": false
},
"focus": {
"type": "object",
"required": [
"path",
"offset",
"text"
],
"properties": {
"path": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"maxItems": 64
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"text": {
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"editor": {
"anyOf": [
{
"type": "string",
"enum": [
"codemirror5"
]
},
{
"type": "string",
"enum": [
"codemirror6"
]
},
{
"type": "string",
"enum": [
"monaco"
]
},
{
"type": "string",
"enum": [
"ace"
]
},
{
"type": "string",
"enum": [
"quill"
]
},
{
"type": "string",
"enum": [
"tinymce"
]
}
]
},
"editor_selections": {
"type": "array",
"items": {
"type": "object",
"required": [
"anchor",
"head"
],
"properties": {
"anchor": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"head": {
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 100
},
"editor_primary": {
"type": "integer",
"minimum": 0,
"maximum": 99
},
"selection_only": {
"type": "boolean"
},
"input_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"append"
]
},
{
"type": "string",
"enum": [
"replace"
]
}
]
},
"text_selection": {
"type": "object",
"required": [
"start",
"end",
"direction"
],
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"direction": {
"anyOf": [
{
"type": "string",
"enum": [
"forward"
]
},
{
"type": "string",
"enum": [
"backward"
]
},
{
"type": "string",
"enum": [
"none"
]
}
]
}
},
"additionalProperties": false
},
"navigation_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"always"
]
},
{
"type": "string",
"enum": [
"if_needed"
]
}
]
},
"scroll_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"relative"
]
},
{
"type": "string",
"enum": [
"absolute"
]
}
]
},
"tab_reuse": {
"type": "boolean"
},
"breakpoint": {
"type": "boolean"
},
"position": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 10000
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 200000
}
},
"additionalProperties": false
},
"action": {
"anyOf": [
{
"type": "string",
"enum": [
"navigate"
]
},
{
"type": "string",
"enum": [
"click"
]
},
{
"type": "string",
"enum": [
"drag"
]
},
{
"type": "string",
"enum": [
"upload"
]
},
{
"type": "string",
"enum": [
"dialog"
]
},
{
"type": "string",
"enum": [
"type"
]
},
{
"type": "string",
"enum": [
"key"
]
},
{
"type": "string",
"enum": [
"wait"
]
},
{
"type": "string",
"enum": [
"manual_wait"
]
},
{
"type": "string",
"enum": [
"wait_selector"
]
},
{
"type": "string",
"enum": [
"extract"
]
},
{
"type": "string",
"enum": [
"page_data"
]
},
{
"type": "string",
"enum": [
"tab_open"
]
},
{
"type": "string",
"enum": [
"tab_switch"
]
},
{
"type": "string",
"enum": [
"tab_close"
]
},
{
"type": "string",
"enum": [
"frame_enter"
]
},
{
"type": "string",
"enum": [
"frame_parent"
]
},
{
"type": "string",
"enum": [
"frame_top"
]
},
{
"type": "string",
"enum": [
"reload"
]
},
{
"type": "string",
"enum": [
"hover"
]
},
{
"type": "string",
"enum": [
"double_click"
]
},
{
"type": "string",
"enum": [
"right_click"
]
},
{
"type": "string",
"enum": [
"scroll"
]
},
{
"type": "string",
"enum": [
"select"
]
},
{
"type": "string",
"enum": [
"attribute"
]
},
{
"type": "string",
"enum": [
"screenshot"
]
},
{
"type": "string",
"enum": [
"cookies_get"
]
},
{
"type": "string",
"enum": [
"cookies_set"
]
},
{
"type": "string",
"enum": [
"cookies_delete"
]
},
{
"type": "string",
"enum": [
"focus"
]
},
{
"type": "string",
"enum": [
"exists"
]
},
{
"type": "string",
"enum": [
"attribute_set"
]
},
{
"type": "string",
"enum": [
"mouse_move"
]
},
{
"type": "string",
"enum": [
"wheel"
]
},
{
"type": "string",
"enum": [
"history_back"
]
},
{
"type": "string",
"enum": [
"history_forward"
]
},
{
"type": "string",
"enum": [
"tab_list"
]
},
{
"type": "string",
"enum": [
"tab_activate"
]
},
{
"type": "string",
"enum": [
"script"
]
},
{
"type": "string",
"enum": [
"workflow_call"
]
},
{
"type": "string",
"enum": [
"branch"
]
},
{
"type": "string",
"enum": [
"loop_count"
]
},
{
"type": "string",
"enum": [
"loop_data"
]
},
{
"type": "string",
"enum": [
"loop_elements"
]
},
{
"type": "string",
"enum": [
"element_capture"
]
},
{
"type": "string",
"enum": [
"element_release"
]
},
{
"type": "string",
"enum": [
"loop_while"
]
},
{
"type": "string",
"enum": [
"loop_break"
]
},
{
"type": "string",
"enum": [
"loop_continue"
]
},
{
"type": "string",
"enum": [
"variable_set"
]
},
{
"type": "string",
"enum": [
"global"
]
},
{
"type": "string",
"enum": [
"data_transform"
]
},
{
"type": "string",
"enum": [
"file"
]
},
{
"type": "string",
"enum": [
"service"
]
},
{
"type": "string",
"enum": [
"network"
]
}
]
},
"data": {
"type": "object",
"required": [
"operation"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"csv_parse"
]
},
{
"type": "string",
"enum": [
"csv_stringify"
]
},
{
"type": "string",
"enum": [
"table_cell"
]
},
{
"type": "string",
"enum": [
"table_set"
]
},
{
"type": "string",
"enum": [
"table_row"
]
},
{
"type": "string",
"enum": [
"table_column"
]
},
{
"type": "string",
"enum": [
"table_append"
]
},
{
"type": "string",
"enum": [
"table_slice"
]
},
{
"type": "string",
"enum": [
"json_parse"
]
},
{
"type": "string",
"enum": [
"json_get"
]
},
{
"type": "string",
"enum": [
"json_keys"
]
},
{
"type": "string",
"enum": [
"list_length"
]
},
{
"type": "string",
"enum": [
"list_join"
]
},
{
"type": "string",
"enum": [
"list_append"
]
},
{
"type": "string",
"enum": [
"list_random"
]
},
{
"type": "string",
"enum": [
"text_split"
]
},
{
"type": "string",
"enum": [
"text_replace"
]
},
{
"type": "string",
"enum": [
"regex_extract"
]
},
{
"type": "string",
"enum": [
"regex_replace"
]
},
{
"type": "string",
"enum": [
"text_trim"
]
},
{
"type": "string",
"enum": [
"text_lower"
]
},
{
"type": "string",
"enum": [
"text_upper"
]
},
{
"type": "string",
"enum": [
"number_add"
]
},
{
"type": "string",
"enum": [
"number_subtract"
]
},
{
"type": "string",
"enum": [
"number_multiply"
]
},
{
"type": "string",
"enum": [
"number_divide"
]
},
{
"type": "string",
"enum": [
"number_remainder"
]
},
{
"type": "string",
"enum": [
"url_parse"
]
},
{
"type": "string",
"enum": [
"url_parameter"
]
},
{
"type": "string",
"enum": [
"random_integer"
]
},
{
"type": "string",
"enum": [
"random_text"
]
}
]
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
}
},
"additionalProperties": false
},
"global": {
"type": "object",
"required": [
"operation",
"name"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"read"
]
},
{
"type": "string",
"enum": [
"write"
]
},
{
"type": "string",
"enum": [
"delete"
]
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"expected_revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"additionalProperties": false
},
"page_data": {
"anyOf": [
{
"type": "string",
"enum": [
"url"
]
},
{
"type": "string",
"enum": [
"title"
]
},
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"html"
]
},
{
"type": "string",
"enum": [
"links"
]
},
{
"type": "string",
"enum": [
"images"
]
},
{
"type": "string",
"enum": [
"form_values"
]
},
{
"type": "string",
"enum": [
"element_count"
]
}
]
},
"file": {
"type": "object",
"required": [
"operation",
"format",
"name"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"read"
]
},
{
"type": "string",
"enum": [
"write"
]
},
{
"type": "string",
"enum": [
"append"
]
}
]
},
"format": {
"anyOf": [
{
"type": "string",
"enum": [
"txt"
]
},
{
"type": "string",
"enum": [
"json"
]
},
{
"type": "string",
"enum": [
"csv"
]
},
{
"type": "string",
"enum": [
"xlsx"
]
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"delimiter": {
"anyOf": [
{
"type": "string",
"enum": [
","
]
},
{
"type": "string",
"enum": [
";"
]
},
{
"type": "string",
"enum": [
"\t"
]
},
{
"type": "string",
"enum": [
"|"
]
}
]
},
"sheet": {
"type": "string",
"minLength": 1,
"maxLength": 31
},
"overwrite": {
"type": "boolean"
}
},
"additionalProperties": false
},
"service": {
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"http"
]
},
{
"type": "string",
"enum": [
"google_sheets"
]
},
{
"type": "string",
"enum": [
"otp"
]
}
]
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
}
},
"additionalProperties": false
},
"network": {
"type": "object",
"required": [
"operation"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"start"
]
},
{
"type": "string",
"enum": [
"read"
]
},
{
"type": "string",
"enum": [
"stop"
]
}
]
},
"url_contains": {
"type": "string",
"maxLength": 2000
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"all"
]
},
{
"type": "string",
"enum": [
"request"
]
},
{
"type": "string",
"enum": [
"response"
]
},
{
"type": "string",
"enum": [
"error"
]
}
]
},
"include_headers": {
"type": "boolean"
},
"include_bodies": {
"type": "boolean"
},
"max_events": {
"type": "integer",
"minimum": 1,
"maximum": 1000
}
},
"additionalProperties": false
},
"selector": {
"type": "string",
"maxLength": 2000
},
"element_ref": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"workflow_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"else_workflow_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"predicate": {
"type": "object",
"required": [
"variable",
"operator"
],
"properties": {
"variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"operator": {
"anyOf": [
{
"type": "string",
"enum": [
"exists"
]
},
{
"type": "string",
"enum": [
"not_exists"
]
},
{
"type": "string",
"enum": [
"equals"
]
},
{
"type": "string",
"enum": [
"not_equals"
]
},
{
"type": "string",
"enum": [
"contains"
]
},
{
"type": "string",
"enum": [
"not_contains"
]
},
{
"type": "string",
"enum": [
"starts_with"
]
},
{
"type": "string",
"enum": [
"ends_with"
]
},
{
"type": "string",
"enum": [
"less"
]
},
{
"type": "string",
"enum": [
"less_equal"
]
},
{
"type": "string",
"enum": [
"greater"
]
},
{
"type": "string",
"enum": [
"greater_equal"
]
},
{
"type": "string",
"enum": [
"one_of"
]
},
{
"type": "string",
"enum": [
"not_one_of"
]
}
]
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"number"
]
}
]
}
},
"additionalProperties": false
},
"data_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"item_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"index_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"loop_start": {
"type": "integer",
"minimum": 0,
"maximum": 9999
},
"max_iterations": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"script_variables": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"maxItems": 64,
"uniqueItems": true
},
"element_index": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"element_random_min": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"element_random_max": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"tab_match": {
"anyOf": [
{
"type": "string",
"enum": [
"id"
]
},
{
"type": "string",
"enum": [
"url"
]
},
{
"type": "string",
"enum": [
"title"
]
},
{
"type": "string",
"enum": [
"next"
]
},
{
"type": "string",
"enum": [
"previous"
]
},
{
"type": "string",
"enum": [
"index"
]
}
]
},
"tab_compare": {
"anyOf": [
{
"type": "string",
"enum": [
"equals"
]
},
{
"type": "string",
"enum": [
"not_equals"
]
},
{
"type": "string",
"enum": [
"contains"
]
},
{
"type": "string",
"enum": [
"not_contains"
]
},
{
"type": "string",
"enum": [
"starts_with"
]
},
{
"type": "string",
"enum": [
"ends_with"
]
}
]
},
"tab_wrap": {
"type": "boolean"
},
"scroll_x": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"scroll_y": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"full_page": {
"type": "boolean"
},
"screenshot_format": {
"anyOf": [
{
"type": "string",
"enum": [
"png"
]
},
{
"type": "string",
"enum": [
"jpeg"
]
}
]
},
"screenshot_frame_content": {
"type": "boolean"
},
"screenshot_output": {
"anyOf": [
{
"type": "string",
"enum": [
"file"
]
},
{
"type": "string",
"enum": [
"base64"
]
}
]
},
"screenshot_quality": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"screenshot_name": {
"type": "string",
"maxLength": 100
},
"dialog": {
"type": "object",
"required": [
"type",
"accept"
],
"properties": {
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"alert"
]
},
{
"type": "string",
"enum": [
"confirm"
]
},
{
"type": "string",
"enum": [
"prompt"
]
},
{
"type": "string",
"enum": [
"beforeunload"
]
}
]
},
"accept": {
"type": "boolean"
},
"message": {
"type": "string",
"maxLength": 4000
}
},
"additionalProperties": false
},
"drag": {
"type": "object",
"required": [
"path"
],
"properties": {
"target": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"target_tab": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"target_frames": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"maxItems": 16
},
"coordinate_space": {
"type": "string",
"enum": [
"top"
]
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"additionalProperties": false
},
"path": {
"type": "array",
"items": {
"type": "object",
"required": [
"x",
"y",
"t"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"t": {
"type": "integer",
"minimum": 0,
"maximum": 30000
},
"tab": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"scroll": {
"type": "array",
"items": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"selector": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"frames": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"maxItems": 16
},
"x": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"y": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
}
},
"additionalProperties": false
},
"maxItems": 32
}
},
"additionalProperties": false
},
"minItems": 2,
"maxItems": 256
}
},
"additionalProperties": false
},
"file_chooser": {
"anyOf": [
{
"type": "string",
"enum": [
"select"
]
},
{
"type": "string",
"enum": [
"cancel"
]
}
]
},
"uploads": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"size",
"sha256"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9-]{36}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"size": {
"type": "integer",
"minimum": 0,
"maximum": 104857600
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"last_modified": {
"type": "integer",
"minimum": 0,
"maximum": 8640000000000000
}
},
"additionalProperties": false
},
"maxItems": 100
},
"selection": {
"type": "array",
"items": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"maxLength": 10000
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
"additionalProperties": false
},
"maxItems": 1000
},
"pointer_offset": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"additionalProperties": false
},
"pointer_x": {
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"pointer_y": {
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"wait_ms": {
"type": "integer",
"minimum": 0,
"maximum": 119000
},
"attribute_name": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"secret_value": {
"type": "boolean"
},
"value_missing": {
"type": "boolean"
},
"cookie_domain": {
"type": "string",
"maxLength": 253
},
"cookie_name": {
"type": "string",
"maxLength": 1024
},
"cookie_path": {
"type": "string",
"maxLength": 2048
},
"cookie_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"merge"
]
},
{
"type": "string",
"enum": [
"replace"
]
}
]
},
"cookie_output": {
"anyOf": [
{
"type": "string",
"enum": [
"json"
]
},
{
"type": "string",
"enum": [
"netscape"
]
},
{
"type": "string",
"enum": [
"header"
]
},
{
"type": "string",
"enum": [
"value"
]
}
]
},
"value": {
"type": "string",
"maxLength": 10000
},
"save_as": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"repeat": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"retries": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"timeout_ms": {
"type": "integer",
"minimum": 100,
"maximum": 120000
},
"on_error": {
"anyOf": [
{
"type": "string",
"enum": [
"stop"
]
},
{
"type": "string",
"enum": [
"continue"
]
}
]
},
"condition": {
"type": "object",
"required": [
"variable",
"equals"
],
"properties": {
"variable": {
"type": "string",
"maxLength": 64
},
"equals": {
"type": "string",
"maxLength": 10000
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 200
},
"profile_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 500,
"uniqueItems": true
},
"concurrency": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"priority": {
"anyOf": [
{
"type": "string",
"enum": [
"low"
]
},
{
"type": "string",
"enum": [
"normal"
]
},
{
"type": "string",
"enum": [
"high"
]
}
]
},
"close_after": {
"type": "boolean"
},
"headless": {
"type": "boolean"
},
"browser": {
"type": "object",
"required": [
"provider",
"session_ttl"
],
"properties": {
"provider": {
"type": "string",
"enum": [
"zenrows"
]
},
"persist_cookies": {
"type": "boolean"
},
"persist_tabs": {
"type": "boolean"
},
"persist_local_storage": {
"type": "boolean"
},
"persist_indexed_db": {
"type": "boolean"
},
"persist_history": {
"type": "boolean"
},
"session_ttl": {
"type": "integer",
"minimum": 60,
"maximum": 900
},
"proxy_country": {
"type": "string",
"pattern": "^[a-z]{2}$"
}
},
"additionalProperties": false
},
"delay_ms": {
"type": "integer",
"minimum": 0,
"maximum": 30000
},
"input_timing": {
"type": "object",
"required": [
"key_min_ms",
"key_max_ms",
"step_jitter_ms"
],
"properties": {
"key_min_ms": {
"type": "integer",
"minimum": 0,
"maximum": 2000
},
"key_max_ms": {
"type": "integer",
"minimum": 0,
"maximum": 2000
},
"step_jitter_ms": {
"type": "integer",
"minimum": 0,
"maximum": 30000
},
"mouse_min_ms": {
"type": "integer",
"minimum": 0,
"maximum": 5000
},
"mouse_max_ms": {
"type": "integer",
"minimum": 0,
"maximum": 5000
}
},
"additionalProperties": false
},
"schedule": {
"anyOf": [
{
"type": "object",
"required": [
"next_at",
"interval_minutes"
],
"properties": {
"next_at": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799999
},
"interval_minutes": {
"type": "integer",
"minimum": 0,
"maximum": 525600
},
"time_zone": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"remaining_runs": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"end_at": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799999
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"calendar": {
"type": "object",
"required": [
"frequency",
"start_date",
"time"
],
"properties": {
"frequency": {
"anyOf": [
{
"type": "string",
"enum": [
"daily"
]
},
{
"type": "string",
"enum": [
"weekly"
]
},
{
"type": "string",
"enum": [
"monthly"
]
},
{
"type": "string",
"enum": [
"yearly"
]
}
]
},
"start_date": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"time": {
"type": "string",
"pattern": "^[0-9]{2}:[0-9]{2}$"
},
"weekdays": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 7
},
"minItems": 1,
"maxItems": 7,
"uniqueItems": true
},
"month": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"month_day": {
"anyOf": [
{
"type": "number",
"enum": [
-1
]
},
{
"type": "integer",
"minimum": 1,
"maximum": 31
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
}
}
}
}
}
}default · HTTP error envelope. The status and error.code identify the failure.
OpenAPI JSON
{
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}General authentication and transport errors may occur in addition to the documented responses.
OpenAPI definition#
Complete operation definition
OpenAPI JSON
{
"summary": "RPA-Ablauf ändern",
"tags": [
"Automation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"steps",
"profile_ids",
"concurrency",
"close_after",
"delay_ms",
"schedule"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"group": {
"type": "string",
"maxLength": 80
},
"description": {
"type": "string",
"maxLength": 2000
},
"is_template": {
"type": "boolean"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"action"
],
"properties": {
"node_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"next_step": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
{
"type": "null"
}
]
},
"else_step": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
{
"type": "null"
}
]
},
"route_when": {
"type": "object",
"required": [
"variable",
"operator"
],
"properties": {
"variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"operator": {
"anyOf": [
{
"type": "string",
"enum": [
"exists"
]
},
{
"type": "string",
"enum": [
"not_exists"
]
},
{
"type": "string",
"enum": [
"equals"
]
},
{
"type": "string",
"enum": [
"not_equals"
]
},
{
"type": "string",
"enum": [
"contains"
]
},
{
"type": "string",
"enum": [
"not_contains"
]
},
{
"type": "string",
"enum": [
"starts_with"
]
},
{
"type": "string",
"enum": [
"ends_with"
]
},
{
"type": "string",
"enum": [
"less"
]
},
{
"type": "string",
"enum": [
"less_equal"
]
},
{
"type": "string",
"enum": [
"greater"
]
},
{
"type": "string",
"enum": [
"greater_equal"
]
},
{
"type": "string",
"enum": [
"one_of"
]
},
{
"type": "string",
"enum": [
"not_one_of"
]
}
]
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"number"
]
}
]
}
},
"additionalProperties": false
},
"route_value": {
"type": "string",
"maxLength": 10000
},
"input_format": {
"anyOf": [
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"html"
]
}
]
},
"editable_selection": {
"type": "object",
"required": [
"anchor",
"focus"
],
"properties": {
"anchor": {
"type": "object",
"required": [
"path",
"offset",
"text"
],
"properties": {
"path": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"maxItems": 64
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"text": {
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
"additionalProperties": false
},
"focus": {
"type": "object",
"required": [
"path",
"offset",
"text"
],
"properties": {
"path": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"maxItems": 64
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"text": {
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"editor": {
"anyOf": [
{
"type": "string",
"enum": [
"codemirror5"
]
},
{
"type": "string",
"enum": [
"codemirror6"
]
},
{
"type": "string",
"enum": [
"monaco"
]
},
{
"type": "string",
"enum": [
"ace"
]
},
{
"type": "string",
"enum": [
"quill"
]
},
{
"type": "string",
"enum": [
"tinymce"
]
}
]
},
"editor_selections": {
"type": "array",
"items": {
"type": "object",
"required": [
"anchor",
"head"
],
"properties": {
"anchor": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"head": {
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 100
},
"editor_primary": {
"type": "integer",
"minimum": 0,
"maximum": 99
},
"selection_only": {
"type": "boolean"
},
"input_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"append"
]
},
{
"type": "string",
"enum": [
"replace"
]
}
]
},
"text_selection": {
"type": "object",
"required": [
"start",
"end",
"direction"
],
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"direction": {
"anyOf": [
{
"type": "string",
"enum": [
"forward"
]
},
{
"type": "string",
"enum": [
"backward"
]
},
{
"type": "string",
"enum": [
"none"
]
}
]
}
},
"additionalProperties": false
},
"navigation_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"always"
]
},
{
"type": "string",
"enum": [
"if_needed"
]
}
]
},
"scroll_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"relative"
]
},
{
"type": "string",
"enum": [
"absolute"
]
}
]
},
"tab_reuse": {
"type": "boolean"
},
"breakpoint": {
"type": "boolean"
},
"position": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 10000
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 200000
}
},
"additionalProperties": false
},
"action": {
"anyOf": [
{
"type": "string",
"enum": [
"navigate"
]
},
{
"type": "string",
"enum": [
"click"
]
},
{
"type": "string",
"enum": [
"drag"
]
},
{
"type": "string",
"enum": [
"upload"
]
},
{
"type": "string",
"enum": [
"dialog"
]
},
{
"type": "string",
"enum": [
"type"
]
},
{
"type": "string",
"enum": [
"key"
]
},
{
"type": "string",
"enum": [
"wait"
]
},
{
"type": "string",
"enum": [
"manual_wait"
]
},
{
"type": "string",
"enum": [
"wait_selector"
]
},
{
"type": "string",
"enum": [
"extract"
]
},
{
"type": "string",
"enum": [
"page_data"
]
},
{
"type": "string",
"enum": [
"tab_open"
]
},
{
"type": "string",
"enum": [
"tab_switch"
]
},
{
"type": "string",
"enum": [
"tab_close"
]
},
{
"type": "string",
"enum": [
"frame_enter"
]
},
{
"type": "string",
"enum": [
"frame_parent"
]
},
{
"type": "string",
"enum": [
"frame_top"
]
},
{
"type": "string",
"enum": [
"reload"
]
},
{
"type": "string",
"enum": [
"hover"
]
},
{
"type": "string",
"enum": [
"double_click"
]
},
{
"type": "string",
"enum": [
"right_click"
]
},
{
"type": "string",
"enum": [
"scroll"
]
},
{
"type": "string",
"enum": [
"select"
]
},
{
"type": "string",
"enum": [
"attribute"
]
},
{
"type": "string",
"enum": [
"screenshot"
]
},
{
"type": "string",
"enum": [
"cookies_get"
]
},
{
"type": "string",
"enum": [
"cookies_set"
]
},
{
"type": "string",
"enum": [
"cookies_delete"
]
},
{
"type": "string",
"enum": [
"focus"
]
},
{
"type": "string",
"enum": [
"exists"
]
},
{
"type": "string",
"enum": [
"attribute_set"
]
},
{
"type": "string",
"enum": [
"mouse_move"
]
},
{
"type": "string",
"enum": [
"wheel"
]
},
{
"type": "string",
"enum": [
"history_back"
]
},
{
"type": "string",
"enum": [
"history_forward"
]
},
{
"type": "string",
"enum": [
"tab_list"
]
},
{
"type": "string",
"enum": [
"tab_activate"
]
},
{
"type": "string",
"enum": [
"script"
]
},
{
"type": "string",
"enum": [
"workflow_call"
]
},
{
"type": "string",
"enum": [
"branch"
]
},
{
"type": "string",
"enum": [
"loop_count"
]
},
{
"type": "string",
"enum": [
"loop_data"
]
},
{
"type": "string",
"enum": [
"loop_elements"
]
},
{
"type": "string",
"enum": [
"element_capture"
]
},
{
"type": "string",
"enum": [
"element_release"
]
},
{
"type": "string",
"enum": [
"loop_while"
]
},
{
"type": "string",
"enum": [
"loop_break"
]
},
{
"type": "string",
"enum": [
"loop_continue"
]
},
{
"type": "string",
"enum": [
"variable_set"
]
},
{
"type": "string",
"enum": [
"global"
]
},
{
"type": "string",
"enum": [
"data_transform"
]
},
{
"type": "string",
"enum": [
"file"
]
},
{
"type": "string",
"enum": [
"service"
]
},
{
"type": "string",
"enum": [
"network"
]
}
]
},
"data": {
"type": "object",
"required": [
"operation"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"csv_parse"
]
},
{
"type": "string",
"enum": [
"csv_stringify"
]
},
{
"type": "string",
"enum": [
"table_cell"
]
},
{
"type": "string",
"enum": [
"table_set"
]
},
{
"type": "string",
"enum": [
"table_row"
]
},
{
"type": "string",
"enum": [
"table_column"
]
},
{
"type": "string",
"enum": [
"table_append"
]
},
{
"type": "string",
"enum": [
"table_slice"
]
},
{
"type": "string",
"enum": [
"json_parse"
]
},
{
"type": "string",
"enum": [
"json_get"
]
},
{
"type": "string",
"enum": [
"json_keys"
]
},
{
"type": "string",
"enum": [
"list_length"
]
},
{
"type": "string",
"enum": [
"list_join"
]
},
{
"type": "string",
"enum": [
"list_append"
]
},
{
"type": "string",
"enum": [
"list_random"
]
},
{
"type": "string",
"enum": [
"text_split"
]
},
{
"type": "string",
"enum": [
"text_replace"
]
},
{
"type": "string",
"enum": [
"regex_extract"
]
},
{
"type": "string",
"enum": [
"regex_replace"
]
},
{
"type": "string",
"enum": [
"text_trim"
]
},
{
"type": "string",
"enum": [
"text_lower"
]
},
{
"type": "string",
"enum": [
"text_upper"
]
},
{
"type": "string",
"enum": [
"number_add"
]
},
{
"type": "string",
"enum": [
"number_subtract"
]
},
{
"type": "string",
"enum": [
"number_multiply"
]
},
{
"type": "string",
"enum": [
"number_divide"
]
},
{
"type": "string",
"enum": [
"number_remainder"
]
},
{
"type": "string",
"enum": [
"url_parse"
]
},
{
"type": "string",
"enum": [
"url_parameter"
]
},
{
"type": "string",
"enum": [
"random_integer"
]
},
{
"type": "string",
"enum": [
"random_text"
]
}
]
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
}
},
"additionalProperties": false
},
"global": {
"type": "object",
"required": [
"operation",
"name"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"read"
]
},
{
"type": "string",
"enum": [
"write"
]
},
{
"type": "string",
"enum": [
"delete"
]
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"expected_revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"additionalProperties": false
},
"page_data": {
"anyOf": [
{
"type": "string",
"enum": [
"url"
]
},
{
"type": "string",
"enum": [
"title"
]
},
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"html"
]
},
{
"type": "string",
"enum": [
"links"
]
},
{
"type": "string",
"enum": [
"images"
]
},
{
"type": "string",
"enum": [
"form_values"
]
},
{
"type": "string",
"enum": [
"element_count"
]
}
]
},
"file": {
"type": "object",
"required": [
"operation",
"format",
"name"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"read"
]
},
{
"type": "string",
"enum": [
"write"
]
},
{
"type": "string",
"enum": [
"append"
]
}
]
},
"format": {
"anyOf": [
{
"type": "string",
"enum": [
"txt"
]
},
{
"type": "string",
"enum": [
"json"
]
},
{
"type": "string",
"enum": [
"csv"
]
},
{
"type": "string",
"enum": [
"xlsx"
]
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"delimiter": {
"anyOf": [
{
"type": "string",
"enum": [
","
]
},
{
"type": "string",
"enum": [
";"
]
},
{
"type": "string",
"enum": [
"\t"
]
},
{
"type": "string",
"enum": [
"|"
]
}
]
},
"sheet": {
"type": "string",
"minLength": 1,
"maxLength": 31
},
"overwrite": {
"type": "boolean"
}
},
"additionalProperties": false
},
"service": {
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"http"
]
},
{
"type": "string",
"enum": [
"google_sheets"
]
},
{
"type": "string",
"enum": [
"otp"
]
}
]
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
}
},
"additionalProperties": false
},
"network": {
"type": "object",
"required": [
"operation"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"start"
]
},
{
"type": "string",
"enum": [
"read"
]
},
{
"type": "string",
"enum": [
"stop"
]
}
]
},
"url_contains": {
"type": "string",
"maxLength": 2000
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"all"
]
},
{
"type": "string",
"enum": [
"request"
]
},
{
"type": "string",
"enum": [
"response"
]
},
{
"type": "string",
"enum": [
"error"
]
}
]
},
"include_headers": {
"type": "boolean"
},
"include_bodies": {
"type": "boolean"
},
"max_events": {
"type": "integer",
"minimum": 1,
"maximum": 1000
}
},
"additionalProperties": false
},
"selector": {
"type": "string",
"maxLength": 2000
},
"element_ref": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"workflow_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"else_workflow_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"predicate": {
"type": "object",
"required": [
"variable",
"operator"
],
"properties": {
"variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"operator": {
"anyOf": [
{
"type": "string",
"enum": [
"exists"
]
},
{
"type": "string",
"enum": [
"not_exists"
]
},
{
"type": "string",
"enum": [
"equals"
]
},
{
"type": "string",
"enum": [
"not_equals"
]
},
{
"type": "string",
"enum": [
"contains"
]
},
{
"type": "string",
"enum": [
"not_contains"
]
},
{
"type": "string",
"enum": [
"starts_with"
]
},
{
"type": "string",
"enum": [
"ends_with"
]
},
{
"type": "string",
"enum": [
"less"
]
},
{
"type": "string",
"enum": [
"less_equal"
]
},
{
"type": "string",
"enum": [
"greater"
]
},
{
"type": "string",
"enum": [
"greater_equal"
]
},
{
"type": "string",
"enum": [
"one_of"
]
},
{
"type": "string",
"enum": [
"not_one_of"
]
}
]
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"number"
]
}
]
}
},
"additionalProperties": false
},
"data_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"item_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"index_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"loop_start": {
"type": "integer",
"minimum": 0,
"maximum": 9999
},
"max_iterations": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"script_variables": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"maxItems": 64,
"uniqueItems": true
},
"element_index": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"element_random_min": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"element_random_max": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"tab_match": {
"anyOf": [
{
"type": "string",
"enum": [
"id"
]
},
{
"type": "string",
"enum": [
"url"
]
},
{
"type": "string",
"enum": [
"title"
]
},
{
"type": "string",
"enum": [
"next"
]
},
{
"type": "string",
"enum": [
"previous"
]
},
{
"type": "string",
"enum": [
"index"
]
}
]
},
"tab_compare": {
"anyOf": [
{
"type": "string",
"enum": [
"equals"
]
},
{
"type": "string",
"enum": [
"not_equals"
]
},
{
"type": "string",
"enum": [
"contains"
]
},
{
"type": "string",
"enum": [
"not_contains"
]
},
{
"type": "string",
"enum": [
"starts_with"
]
},
{
"type": "string",
"enum": [
"ends_with"
]
}
]
},
"tab_wrap": {
"type": "boolean"
},
"scroll_x": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"scroll_y": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"full_page": {
"type": "boolean"
},
"screenshot_format": {
"anyOf": [
{
"type": "string",
"enum": [
"png"
]
},
{
"type": "string",
"enum": [
"jpeg"
]
}
]
},
"screenshot_frame_content": {
"type": "boolean"
},
"screenshot_output": {
"anyOf": [
{
"type": "string",
"enum": [
"file"
]
},
{
"type": "string",
"enum": [
"base64"
]
}
]
},
"screenshot_quality": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"screenshot_name": {
"type": "string",
"maxLength": 100
},
"dialog": {
"type": "object",
"required": [
"type",
"accept"
],
"properties": {
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"alert"
]
},
{
"type": "string",
"enum": [
"confirm"
]
},
{
"type": "string",
"enum": [
"prompt"
]
},
{
"type": "string",
"enum": [
"beforeunload"
]
}
]
},
"accept": {
"type": "boolean"
},
"message": {
"type": "string",
"maxLength": 4000
}
},
"additionalProperties": false
},
"drag": {
"type": "object",
"required": [
"path"
],
"properties": {
"target": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"target_tab": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"target_frames": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"maxItems": 16
},
"coordinate_space": {
"type": "string",
"enum": [
"top"
]
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"additionalProperties": false
},
"path": {
"type": "array",
"items": {
"type": "object",
"required": [
"x",
"y",
"t"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"t": {
"type": "integer",
"minimum": 0,
"maximum": 30000
},
"tab": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"scroll": {
"type": "array",
"items": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"selector": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"frames": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"maxItems": 16
},
"x": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"y": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
}
},
"additionalProperties": false
},
"maxItems": 32
}
},
"additionalProperties": false
},
"minItems": 2,
"maxItems": 256
}
},
"additionalProperties": false
},
"file_chooser": {
"anyOf": [
{
"type": "string",
"enum": [
"select"
]
},
{
"type": "string",
"enum": [
"cancel"
]
}
]
},
"uploads": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"size",
"sha256"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9-]{36}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"size": {
"type": "integer",
"minimum": 0,
"maximum": 104857600
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"last_modified": {
"type": "integer",
"minimum": 0,
"maximum": 8640000000000000
}
},
"additionalProperties": false
},
"maxItems": 100
},
"selection": {
"type": "array",
"items": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"maxLength": 10000
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
"additionalProperties": false
},
"maxItems": 1000
},
"pointer_offset": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"additionalProperties": false
},
"pointer_x": {
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"pointer_y": {
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"wait_ms": {
"type": "integer",
"minimum": 0,
"maximum": 119000
},
"attribute_name": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"secret_value": {
"type": "boolean"
},
"value_missing": {
"type": "boolean"
},
"cookie_domain": {
"type": "string",
"maxLength": 253
},
"cookie_name": {
"type": "string",
"maxLength": 1024
},
"cookie_path": {
"type": "string",
"maxLength": 2048
},
"cookie_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"merge"
]
},
{
"type": "string",
"enum": [
"replace"
]
}
]
},
"cookie_output": {
"anyOf": [
{
"type": "string",
"enum": [
"json"
]
},
{
"type": "string",
"enum": [
"netscape"
]
},
{
"type": "string",
"enum": [
"header"
]
},
{
"type": "string",
"enum": [
"value"
]
}
]
},
"value": {
"type": "string",
"maxLength": 10000
},
"save_as": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"repeat": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"retries": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"timeout_ms": {
"type": "integer",
"minimum": 100,
"maximum": 120000
},
"on_error": {
"anyOf": [
{
"type": "string",
"enum": [
"stop"
]
},
{
"type": "string",
"enum": [
"continue"
]
}
]
},
"condition": {
"type": "object",
"required": [
"variable",
"equals"
],
"properties": {
"variable": {
"type": "string",
"maxLength": 64
},
"equals": {
"type": "string",
"maxLength": 10000
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 200
},
"profile_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 500,
"uniqueItems": true
},
"concurrency": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"priority": {
"anyOf": [
{
"type": "string",
"enum": [
"low"
]
},
{
"type": "string",
"enum": [
"normal"
]
},
{
"type": "string",
"enum": [
"high"
]
}
]
},
"close_after": {
"type": "boolean"
},
"headless": {
"type": "boolean"
},
"browser": {
"type": "object",
"required": [
"provider",
"session_ttl"
],
"properties": {
"provider": {
"type": "string",
"enum": [
"zenrows"
]
},
"persist_cookies": {
"type": "boolean"
},
"persist_tabs": {
"type": "boolean"
},
"persist_local_storage": {
"type": "boolean"
},
"persist_indexed_db": {
"type": "boolean"
},
"persist_history": {
"type": "boolean"
},
"session_ttl": {
"type": "integer",
"minimum": 60,
"maximum": 900
},
"proxy_country": {
"type": "string",
"pattern": "^[a-z]{2}$"
}
},
"additionalProperties": false
},
"delay_ms": {
"type": "integer",
"minimum": 0,
"maximum": 30000
},
"input_timing": {
"type": "object",
"required": [
"key_min_ms",
"key_max_ms",
"step_jitter_ms"
],
"properties": {
"key_min_ms": {
"type": "integer",
"minimum": 0,
"maximum": 2000
},
"key_max_ms": {
"type": "integer",
"minimum": 0,
"maximum": 2000
},
"step_jitter_ms": {
"type": "integer",
"minimum": 0,
"maximum": 30000
},
"mouse_min_ms": {
"type": "integer",
"minimum": 0,
"maximum": 5000
},
"mouse_max_ms": {
"type": "integer",
"minimum": 0,
"maximum": 5000
}
},
"additionalProperties": false
},
"schedule": {
"anyOf": [
{
"type": "object",
"required": [
"next_at",
"interval_minutes"
],
"properties": {
"next_at": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799999
},
"interval_minutes": {
"type": "integer",
"minimum": 0,
"maximum": 525600
},
"time_zone": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"remaining_runs": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"end_at": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799999
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"calendar": {
"type": "object",
"required": [
"frequency",
"start_date",
"time"
],
"properties": {
"frequency": {
"anyOf": [
{
"type": "string",
"enum": [
"daily"
]
},
{
"type": "string",
"enum": [
"weekly"
]
},
{
"type": "string",
"enum": [
"monthly"
]
},
{
"type": "string",
"enum": [
"yearly"
]
}
]
},
"start_date": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"time": {
"type": "string",
"pattern": "^[0-9]{2}:[0-9]{2}$"
},
"weekdays": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 7
},
"minItems": 1,
"maxItems": 7,
"uniqueItems": true
},
"month": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"month_day": {
"anyOf": [
{
"type": "number",
"enum": [
-1
]
},
{
"type": "integer",
"minimum": 1,
"maximum": 31
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9-]{16,64}$"
},
"in": "query",
"name": "operation_id",
"required": false
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"runtime:control",
"rpa:write"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"steps",
"profile_ids",
"concurrency",
"close_after",
"delay_ms",
"schedule",
"id"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"group": {
"type": "string",
"maxLength": 80
},
"description": {
"type": "string",
"maxLength": 2000
},
"is_template": {
"type": "boolean"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"action"
],
"properties": {
"node_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"next_step": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
{
"type": "null"
}
]
},
"else_step": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
{
"type": "null"
}
]
},
"route_when": {
"type": "object",
"required": [
"variable",
"operator"
],
"properties": {
"variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"operator": {
"anyOf": [
{
"type": "string",
"enum": [
"exists"
]
},
{
"type": "string",
"enum": [
"not_exists"
]
},
{
"type": "string",
"enum": [
"equals"
]
},
{
"type": "string",
"enum": [
"not_equals"
]
},
{
"type": "string",
"enum": [
"contains"
]
},
{
"type": "string",
"enum": [
"not_contains"
]
},
{
"type": "string",
"enum": [
"starts_with"
]
},
{
"type": "string",
"enum": [
"ends_with"
]
},
{
"type": "string",
"enum": [
"less"
]
},
{
"type": "string",
"enum": [
"less_equal"
]
},
{
"type": "string",
"enum": [
"greater"
]
},
{
"type": "string",
"enum": [
"greater_equal"
]
},
{
"type": "string",
"enum": [
"one_of"
]
},
{
"type": "string",
"enum": [
"not_one_of"
]
}
]
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"number"
]
}
]
}
},
"additionalProperties": false
},
"route_value": {
"type": "string",
"maxLength": 10000
},
"input_format": {
"anyOf": [
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"html"
]
}
]
},
"editable_selection": {
"type": "object",
"required": [
"anchor",
"focus"
],
"properties": {
"anchor": {
"type": "object",
"required": [
"path",
"offset",
"text"
],
"properties": {
"path": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"maxItems": 64
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"text": {
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
"additionalProperties": false
},
"focus": {
"type": "object",
"required": [
"path",
"offset",
"text"
],
"properties": {
"path": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"maxItems": 64
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"text": {
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"editor": {
"anyOf": [
{
"type": "string",
"enum": [
"codemirror5"
]
},
{
"type": "string",
"enum": [
"codemirror6"
]
},
{
"type": "string",
"enum": [
"monaco"
]
},
{
"type": "string",
"enum": [
"ace"
]
},
{
"type": "string",
"enum": [
"quill"
]
},
{
"type": "string",
"enum": [
"tinymce"
]
}
]
},
"editor_selections": {
"type": "array",
"items": {
"type": "object",
"required": [
"anchor",
"head"
],
"properties": {
"anchor": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"head": {
"type": "integer",
"minimum": 0,
"maximum": 10000
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 100
},
"editor_primary": {
"type": "integer",
"minimum": 0,
"maximum": 99
},
"selection_only": {
"type": "boolean"
},
"input_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"append"
]
},
{
"type": "string",
"enum": [
"replace"
]
}
]
},
"text_selection": {
"type": "object",
"required": [
"start",
"end",
"direction"
],
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"direction": {
"anyOf": [
{
"type": "string",
"enum": [
"forward"
]
},
{
"type": "string",
"enum": [
"backward"
]
},
{
"type": "string",
"enum": [
"none"
]
}
]
}
},
"additionalProperties": false
},
"navigation_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"always"
]
},
{
"type": "string",
"enum": [
"if_needed"
]
}
]
},
"scroll_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"relative"
]
},
{
"type": "string",
"enum": [
"absolute"
]
}
]
},
"tab_reuse": {
"type": "boolean"
},
"breakpoint": {
"type": "boolean"
},
"position": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 10000
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 200000
}
},
"additionalProperties": false
},
"action": {
"anyOf": [
{
"type": "string",
"enum": [
"navigate"
]
},
{
"type": "string",
"enum": [
"click"
]
},
{
"type": "string",
"enum": [
"drag"
]
},
{
"type": "string",
"enum": [
"upload"
]
},
{
"type": "string",
"enum": [
"dialog"
]
},
{
"type": "string",
"enum": [
"type"
]
},
{
"type": "string",
"enum": [
"key"
]
},
{
"type": "string",
"enum": [
"wait"
]
},
{
"type": "string",
"enum": [
"manual_wait"
]
},
{
"type": "string",
"enum": [
"wait_selector"
]
},
{
"type": "string",
"enum": [
"extract"
]
},
{
"type": "string",
"enum": [
"page_data"
]
},
{
"type": "string",
"enum": [
"tab_open"
]
},
{
"type": "string",
"enum": [
"tab_switch"
]
},
{
"type": "string",
"enum": [
"tab_close"
]
},
{
"type": "string",
"enum": [
"frame_enter"
]
},
{
"type": "string",
"enum": [
"frame_parent"
]
},
{
"type": "string",
"enum": [
"frame_top"
]
},
{
"type": "string",
"enum": [
"reload"
]
},
{
"type": "string",
"enum": [
"hover"
]
},
{
"type": "string",
"enum": [
"double_click"
]
},
{
"type": "string",
"enum": [
"right_click"
]
},
{
"type": "string",
"enum": [
"scroll"
]
},
{
"type": "string",
"enum": [
"select"
]
},
{
"type": "string",
"enum": [
"attribute"
]
},
{
"type": "string",
"enum": [
"screenshot"
]
},
{
"type": "string",
"enum": [
"cookies_get"
]
},
{
"type": "string",
"enum": [
"cookies_set"
]
},
{
"type": "string",
"enum": [
"cookies_delete"
]
},
{
"type": "string",
"enum": [
"focus"
]
},
{
"type": "string",
"enum": [
"exists"
]
},
{
"type": "string",
"enum": [
"attribute_set"
]
},
{
"type": "string",
"enum": [
"mouse_move"
]
},
{
"type": "string",
"enum": [
"wheel"
]
},
{
"type": "string",
"enum": [
"history_back"
]
},
{
"type": "string",
"enum": [
"history_forward"
]
},
{
"type": "string",
"enum": [
"tab_list"
]
},
{
"type": "string",
"enum": [
"tab_activate"
]
},
{
"type": "string",
"enum": [
"script"
]
},
{
"type": "string",
"enum": [
"workflow_call"
]
},
{
"type": "string",
"enum": [
"branch"
]
},
{
"type": "string",
"enum": [
"loop_count"
]
},
{
"type": "string",
"enum": [
"loop_data"
]
},
{
"type": "string",
"enum": [
"loop_elements"
]
},
{
"type": "string",
"enum": [
"element_capture"
]
},
{
"type": "string",
"enum": [
"element_release"
]
},
{
"type": "string",
"enum": [
"loop_while"
]
},
{
"type": "string",
"enum": [
"loop_break"
]
},
{
"type": "string",
"enum": [
"loop_continue"
]
},
{
"type": "string",
"enum": [
"variable_set"
]
},
{
"type": "string",
"enum": [
"global"
]
},
{
"type": "string",
"enum": [
"data_transform"
]
},
{
"type": "string",
"enum": [
"file"
]
},
{
"type": "string",
"enum": [
"service"
]
},
{
"type": "string",
"enum": [
"network"
]
}
]
},
"data": {
"type": "object",
"required": [
"operation"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"csv_parse"
]
},
{
"type": "string",
"enum": [
"csv_stringify"
]
},
{
"type": "string",
"enum": [
"table_cell"
]
},
{
"type": "string",
"enum": [
"table_set"
]
},
{
"type": "string",
"enum": [
"table_row"
]
},
{
"type": "string",
"enum": [
"table_column"
]
},
{
"type": "string",
"enum": [
"table_append"
]
},
{
"type": "string",
"enum": [
"table_slice"
]
},
{
"type": "string",
"enum": [
"json_parse"
]
},
{
"type": "string",
"enum": [
"json_get"
]
},
{
"type": "string",
"enum": [
"json_keys"
]
},
{
"type": "string",
"enum": [
"list_length"
]
},
{
"type": "string",
"enum": [
"list_join"
]
},
{
"type": "string",
"enum": [
"list_append"
]
},
{
"type": "string",
"enum": [
"list_random"
]
},
{
"type": "string",
"enum": [
"text_split"
]
},
{
"type": "string",
"enum": [
"text_replace"
]
},
{
"type": "string",
"enum": [
"regex_extract"
]
},
{
"type": "string",
"enum": [
"regex_replace"
]
},
{
"type": "string",
"enum": [
"text_trim"
]
},
{
"type": "string",
"enum": [
"text_lower"
]
},
{
"type": "string",
"enum": [
"text_upper"
]
},
{
"type": "string",
"enum": [
"number_add"
]
},
{
"type": "string",
"enum": [
"number_subtract"
]
},
{
"type": "string",
"enum": [
"number_multiply"
]
},
{
"type": "string",
"enum": [
"number_divide"
]
},
{
"type": "string",
"enum": [
"number_remainder"
]
},
{
"type": "string",
"enum": [
"url_parse"
]
},
{
"type": "string",
"enum": [
"url_parameter"
]
},
{
"type": "string",
"enum": [
"random_integer"
]
},
{
"type": "string",
"enum": [
"random_text"
]
}
]
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
}
},
"additionalProperties": false
},
"global": {
"type": "object",
"required": [
"operation",
"name"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"read"
]
},
{
"type": "string",
"enum": [
"write"
]
},
{
"type": "string",
"enum": [
"delete"
]
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"expected_revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"additionalProperties": false
},
"page_data": {
"anyOf": [
{
"type": "string",
"enum": [
"url"
]
},
{
"type": "string",
"enum": [
"title"
]
},
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"html"
]
},
{
"type": "string",
"enum": [
"links"
]
},
{
"type": "string",
"enum": [
"images"
]
},
{
"type": "string",
"enum": [
"form_values"
]
},
{
"type": "string",
"enum": [
"element_count"
]
}
]
},
"file": {
"type": "object",
"required": [
"operation",
"format",
"name"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"read"
]
},
{
"type": "string",
"enum": [
"write"
]
},
{
"type": "string",
"enum": [
"append"
]
}
]
},
"format": {
"anyOf": [
{
"type": "string",
"enum": [
"txt"
]
},
{
"type": "string",
"enum": [
"json"
]
},
{
"type": "string",
"enum": [
"csv"
]
},
{
"type": "string",
"enum": [
"xlsx"
]
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"delimiter": {
"anyOf": [
{
"type": "string",
"enum": [
","
]
},
{
"type": "string",
"enum": [
";"
]
},
{
"type": "string",
"enum": [
"\t"
]
},
{
"type": "string",
"enum": [
"|"
]
}
]
},
"sheet": {
"type": "string",
"minLength": 1,
"maxLength": 31
},
"overwrite": {
"type": "boolean"
}
},
"additionalProperties": false
},
"service": {
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"http"
]
},
{
"type": "string",
"enum": [
"google_sheets"
]
},
{
"type": "string",
"enum": [
"otp"
]
}
]
},
"source_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
}
},
"additionalProperties": false
},
"network": {
"type": "object",
"required": [
"operation"
],
"properties": {
"operation": {
"anyOf": [
{
"type": "string",
"enum": [
"start"
]
},
{
"type": "string",
"enum": [
"read"
]
},
{
"type": "string",
"enum": [
"stop"
]
}
]
},
"url_contains": {
"type": "string",
"maxLength": 2000
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"all"
]
},
{
"type": "string",
"enum": [
"request"
]
},
{
"type": "string",
"enum": [
"response"
]
},
{
"type": "string",
"enum": [
"error"
]
}
]
},
"include_headers": {
"type": "boolean"
},
"include_bodies": {
"type": "boolean"
},
"max_events": {
"type": "integer",
"minimum": 1,
"maximum": 1000
}
},
"additionalProperties": false
},
"selector": {
"type": "string",
"maxLength": 2000
},
"element_ref": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"workflow_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"else_workflow_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,64}$"
},
"predicate": {
"type": "object",
"required": [
"variable",
"operator"
],
"properties": {
"variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"operator": {
"anyOf": [
{
"type": "string",
"enum": [
"exists"
]
},
{
"type": "string",
"enum": [
"not_exists"
]
},
{
"type": "string",
"enum": [
"equals"
]
},
{
"type": "string",
"enum": [
"not_equals"
]
},
{
"type": "string",
"enum": [
"contains"
]
},
{
"type": "string",
"enum": [
"not_contains"
]
},
{
"type": "string",
"enum": [
"starts_with"
]
},
{
"type": "string",
"enum": [
"ends_with"
]
},
{
"type": "string",
"enum": [
"less"
]
},
{
"type": "string",
"enum": [
"less_equal"
]
},
{
"type": "string",
"enum": [
"greater"
]
},
{
"type": "string",
"enum": [
"greater_equal"
]
},
{
"type": "string",
"enum": [
"one_of"
]
},
{
"type": "string",
"enum": [
"not_one_of"
]
}
]
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"text"
]
},
{
"type": "string",
"enum": [
"number"
]
}
]
}
},
"additionalProperties": false
},
"data_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"item_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"index_variable": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"loop_start": {
"type": "integer",
"minimum": 0,
"maximum": 9999
},
"max_iterations": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"script_variables": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"maxItems": 64,
"uniqueItems": true
},
"element_index": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"element_random_min": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"element_random_max": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"tab_match": {
"anyOf": [
{
"type": "string",
"enum": [
"id"
]
},
{
"type": "string",
"enum": [
"url"
]
},
{
"type": "string",
"enum": [
"title"
]
},
{
"type": "string",
"enum": [
"next"
]
},
{
"type": "string",
"enum": [
"previous"
]
},
{
"type": "string",
"enum": [
"index"
]
}
]
},
"tab_compare": {
"anyOf": [
{
"type": "string",
"enum": [
"equals"
]
},
{
"type": "string",
"enum": [
"not_equals"
]
},
{
"type": "string",
"enum": [
"contains"
]
},
{
"type": "string",
"enum": [
"not_contains"
]
},
{
"type": "string",
"enum": [
"starts_with"
]
},
{
"type": "string",
"enum": [
"ends_with"
]
}
]
},
"tab_wrap": {
"type": "boolean"
},
"scroll_x": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"scroll_y": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"full_page": {
"type": "boolean"
},
"screenshot_format": {
"anyOf": [
{
"type": "string",
"enum": [
"png"
]
},
{
"type": "string",
"enum": [
"jpeg"
]
}
]
},
"screenshot_frame_content": {
"type": "boolean"
},
"screenshot_output": {
"anyOf": [
{
"type": "string",
"enum": [
"file"
]
},
{
"type": "string",
"enum": [
"base64"
]
}
]
},
"screenshot_quality": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"screenshot_name": {
"type": "string",
"maxLength": 100
},
"dialog": {
"type": "object",
"required": [
"type",
"accept"
],
"properties": {
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"alert"
]
},
{
"type": "string",
"enum": [
"confirm"
]
},
{
"type": "string",
"enum": [
"prompt"
]
},
{
"type": "string",
"enum": [
"beforeunload"
]
}
]
},
"accept": {
"type": "boolean"
},
"message": {
"type": "string",
"maxLength": 4000
}
},
"additionalProperties": false
},
"drag": {
"type": "object",
"required": [
"path"
],
"properties": {
"target": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"target_tab": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"target_frames": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"maxItems": 16
},
"coordinate_space": {
"type": "string",
"enum": [
"top"
]
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"additionalProperties": false
},
"path": {
"type": "array",
"items": {
"type": "object",
"required": [
"x",
"y",
"t"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"t": {
"type": "integer",
"minimum": 0,
"maximum": 30000
},
"tab": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"scroll": {
"type": "array",
"items": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"selector": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"frames": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"maxItems": 16
},
"x": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
},
"y": {
"type": "number",
"minimum": -10000000,
"maximum": 10000000
}
},
"additionalProperties": false
},
"maxItems": 32
}
},
"additionalProperties": false
},
"minItems": 2,
"maxItems": 256
}
},
"additionalProperties": false
},
"file_chooser": {
"anyOf": [
{
"type": "string",
"enum": [
"select"
]
},
{
"type": "string",
"enum": [
"cancel"
]
}
]
},
"uploads": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"size",
"sha256"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9-]{36}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"size": {
"type": "integer",
"minimum": 0,
"maximum": 104857600
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"last_modified": {
"type": "integer",
"minimum": 0,
"maximum": 8640000000000000
}
},
"additionalProperties": false
},
"maxItems": 100
},
"selection": {
"type": "array",
"items": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"maxLength": 10000
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 100000
}
},
"additionalProperties": false
},
"maxItems": 1000
},
"pointer_offset": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"y": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"additionalProperties": false
},
"pointer_x": {
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"pointer_y": {
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"wait_ms": {
"type": "integer",
"minimum": 0,
"maximum": 119000
},
"attribute_name": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"secret_value": {
"type": "boolean"
},
"value_missing": {
"type": "boolean"
},
"cookie_domain": {
"type": "string",
"maxLength": 253
},
"cookie_name": {
"type": "string",
"maxLength": 1024
},
"cookie_path": {
"type": "string",
"maxLength": 2048
},
"cookie_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"merge"
]
},
{
"type": "string",
"enum": [
"replace"
]
}
]
},
"cookie_output": {
"anyOf": [
{
"type": "string",
"enum": [
"json"
]
},
{
"type": "string",
"enum": [
"netscape"
]
},
{
"type": "string",
"enum": [
"header"
]
},
{
"type": "string",
"enum": [
"value"
]
}
]
},
"value": {
"type": "string",
"maxLength": 10000
},
"save_as": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
},
"repeat": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"retries": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"timeout_ms": {
"type": "integer",
"minimum": 100,
"maximum": 120000
},
"on_error": {
"anyOf": [
{
"type": "string",
"enum": [
"stop"
]
},
{
"type": "string",
"enum": [
"continue"
]
}
]
},
"condition": {
"type": "object",
"required": [
"variable",
"equals"
],
"properties": {
"variable": {
"type": "string",
"maxLength": 64
},
"equals": {
"type": "string",
"maxLength": 10000
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"minItems": 1,
"maxItems": 200
},
"profile_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 500,
"uniqueItems": true
},
"concurrency": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"priority": {
"anyOf": [
{
"type": "string",
"enum": [
"low"
]
},
{
"type": "string",
"enum": [
"normal"
]
},
{
"type": "string",
"enum": [
"high"
]
}
]
},
"close_after": {
"type": "boolean"
},
"headless": {
"type": "boolean"
},
"browser": {
"type": "object",
"required": [
"provider",
"session_ttl"
],
"properties": {
"provider": {
"type": "string",
"enum": [
"zenrows"
]
},
"persist_cookies": {
"type": "boolean"
},
"persist_tabs": {
"type": "boolean"
},
"persist_local_storage": {
"type": "boolean"
},
"persist_indexed_db": {
"type": "boolean"
},
"persist_history": {
"type": "boolean"
},
"session_ttl": {
"type": "integer",
"minimum": 60,
"maximum": 900
},
"proxy_country": {
"type": "string",
"pattern": "^[a-z]{2}$"
}
},
"additionalProperties": false
},
"delay_ms": {
"type": "integer",
"minimum": 0,
"maximum": 30000
},
"input_timing": {
"type": "object",
"required": [
"key_min_ms",
"key_max_ms",
"step_jitter_ms"
],
"properties": {
"key_min_ms": {
"type": "integer",
"minimum": 0,
"maximum": 2000
},
"key_max_ms": {
"type": "integer",
"minimum": 0,
"maximum": 2000
},
"step_jitter_ms": {
"type": "integer",
"minimum": 0,
"maximum": 30000
},
"mouse_min_ms": {
"type": "integer",
"minimum": 0,
"maximum": 5000
},
"mouse_max_ms": {
"type": "integer",
"minimum": 0,
"maximum": 5000
}
},
"additionalProperties": false
},
"schedule": {
"anyOf": [
{
"type": "object",
"required": [
"next_at",
"interval_minutes"
],
"properties": {
"next_at": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799999
},
"interval_minutes": {
"type": "integer",
"minimum": 0,
"maximum": 525600
},
"time_zone": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"remaining_runs": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"end_at": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799999
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"calendar": {
"type": "object",
"required": [
"frequency",
"start_date",
"time"
],
"properties": {
"frequency": {
"anyOf": [
{
"type": "string",
"enum": [
"daily"
]
},
{
"type": "string",
"enum": [
"weekly"
]
},
{
"type": "string",
"enum": [
"monthly"
]
},
{
"type": "string",
"enum": [
"yearly"
]
}
]
},
"start_date": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"time": {
"type": "string",
"pattern": "^[0-9]{2}:[0-9]{2}$"
},
"weekdays": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 7
},
"minItems": 1,
"maxItems": 7,
"uniqueItems": true
},
"month": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"month_day": {
"anyOf": [
{
"type": "number",
"enum": [
-1
]
},
{
"type": "integer",
"minimum": 1,
"maximum": 31
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}