TabGeckoPOST
/api/v1/automation/workflows/{id}/profiles/{profileId}/run
Start an RPA task once on one profile; retain the saved assignment
Request#
POSIX shell · curl
curl --fail-with-body --request POST \
"$ADBR_API_URL/api/v1/automation/workflows/{id}/profiles/{profileId}/run" \
-H "Authorization: Bearer $ADBR_API_TOKEN" \
-H "Content-Type: application/json" \
--data '{}'Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs.
Authentication and permissions#
Authentication: Bearer token
Scopes: runtime:control, rpa:run
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 |
|---|---|---|---|
id | path | Yes | |
profileId | path | Yes |
Complete parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "profileId",
"required": true
}
]Request body#
No request body declared.
Responses#
200 · Default response
OpenAPI JSON
{
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"workflow_id",
"name",
"state",
"started_at",
"ended_at",
"results"
],
"properties": {
"control": {
"type": "object",
"required": [
"state",
"requested_at"
],
"properties": {
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"pausing"
]
},
{
"type": "string",
"enum": [
"paused"
]
}
]
},
"requested_at": {
"type": "integer"
}
}
},
"recovery": {
"type": "object",
"required": [
"available",
"requires_browser"
],
"properties": {
"available": {
"type": "boolean"
},
"requires_browser": {
"type": "boolean"
},
"browser_snapshot": {
"type": "boolean"
},
"reason": {
"type": "string"
}
}
},
"checkpoint": {
"type": "object",
"required": [
"updated_at",
"safe",
"results"
],
"properties": {
"updated_at": {
"type": "integer"
},
"safe": {
"type": "boolean"
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"step"
],
"properties": {
"profile_id": {
"type": "string"
},
"step": {
"type": "integer"
},
"step_path": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
}
},
"debug": {
"type": "object",
"required": [
"paused"
],
"properties": {
"paused": {
"type": "boolean"
},
"location": {
"type": "object",
"required": [
"profile_id",
"workflow_id",
"path"
],
"properties": {
"profile_id": {
"type": "string"
},
"workflow_id": {
"type": "string"
},
"path": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
},
"id": {
"type": "string"
},
"workflow_id": {
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"running"
]
},
{
"type": "string",
"enum": [
"completed"
]
},
{
"type": "string",
"enum": [
"failed"
]
},
{
"type": "string",
"enum": [
"cancelled"
]
},
{
"type": "string",
"enum": [
"interrupted"
]
}
]
},
"started_at": {
"type": "integer"
},
"ended_at": {
"type": [
"integer",
"null"
]
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"state",
"step",
"error",
"variables"
],
"properties": {
"profile_id": {
"type": "string"
},
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"queued"
]
},
{
"type": "string",
"enum": [
"running"
]
},
{
"type": "string",
"enum": [
"completed"
]
},
{
"type": "string",
"enum": [
"failed"
]
},
{
"type": "string",
"enum": [
"cancelled"
]
}
]
},
"step": {
"type": "integer"
},
"error_phase": {
"type": "string",
"enum": [
"saving_session"
]
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"connecting"
]
},
{
"type": "string",
"enum": [
"waiting_for_cloud"
]
},
{
"type": "string",
"enum": [
"waiting_for_worker"
]
},
{
"type": "string",
"enum": [
"saving_session"
]
}
]
},
"step_path": {
"type": "array",
"items": {
"type": "integer"
}
},
"diagnostics": {
"type": "array",
"items": {
"type": "object",
"required": [
"workflow_id",
"path",
"action",
"repeat",
"attempt",
"started_at",
"duration_ms",
"state"
],
"properties": {
"screenshot": {
"type": "string"
},
"selector": {
"type": "string"
},
"screenshot_omitted": {
"type": "boolean"
},
"workflow_id": {
"type": "string"
},
"path": {
"type": "array",
"items": {
"type": "integer"
}
},
"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"
]
}
]
},
"repeat": {
"type": "integer"
},
"attempt": {
"type": "integer"
},
"started_at": {
"type": "integer"
},
"duration_ms": {
"type": "integer"
},
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"completed"
]
},
{
"type": "string",
"enum": [
"failed"
]
},
{
"type": "string",
"enum": [
"cancelled"
]
},
{
"type": "string",
"enum": [
"control"
]
}
]
},
"error_code": {
"type": "string"
}
}
}
},
"diagnostics_dropped": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
},
"error_code": {
"type": "string"
},
"cleanup_errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"phase",
"message"
],
"properties": {
"phase": {
"type": "string"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"variables": {
"type": "object",
"additionalProperties": {
"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-Aufgabe einmalig auf einem Profil starten; gespeicherte Zuordnung bleibt erhalten",
"tags": [
"Automation"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "profileId",
"required": true
}
],
"x-required-scopes": [
"runtime:control",
"rpa:run"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"workflow_id",
"name",
"state",
"started_at",
"ended_at",
"results"
],
"properties": {
"control": {
"type": "object",
"required": [
"state",
"requested_at"
],
"properties": {
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"pausing"
]
},
{
"type": "string",
"enum": [
"paused"
]
}
]
},
"requested_at": {
"type": "integer"
}
}
},
"recovery": {
"type": "object",
"required": [
"available",
"requires_browser"
],
"properties": {
"available": {
"type": "boolean"
},
"requires_browser": {
"type": "boolean"
},
"browser_snapshot": {
"type": "boolean"
},
"reason": {
"type": "string"
}
}
},
"checkpoint": {
"type": "object",
"required": [
"updated_at",
"safe",
"results"
],
"properties": {
"updated_at": {
"type": "integer"
},
"safe": {
"type": "boolean"
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"step"
],
"properties": {
"profile_id": {
"type": "string"
},
"step": {
"type": "integer"
},
"step_path": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
}
},
"debug": {
"type": "object",
"required": [
"paused"
],
"properties": {
"paused": {
"type": "boolean"
},
"location": {
"type": "object",
"required": [
"profile_id",
"workflow_id",
"path"
],
"properties": {
"profile_id": {
"type": "string"
},
"workflow_id": {
"type": "string"
},
"path": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
},
"id": {
"type": "string"
},
"workflow_id": {
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"running"
]
},
{
"type": "string",
"enum": [
"completed"
]
},
{
"type": "string",
"enum": [
"failed"
]
},
{
"type": "string",
"enum": [
"cancelled"
]
},
{
"type": "string",
"enum": [
"interrupted"
]
}
]
},
"started_at": {
"type": "integer"
},
"ended_at": {
"type": [
"integer",
"null"
]
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"state",
"step",
"error",
"variables"
],
"properties": {
"profile_id": {
"type": "string"
},
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"queued"
]
},
{
"type": "string",
"enum": [
"running"
]
},
{
"type": "string",
"enum": [
"completed"
]
},
{
"type": "string",
"enum": [
"failed"
]
},
{
"type": "string",
"enum": [
"cancelled"
]
}
]
},
"step": {
"type": "integer"
},
"error_phase": {
"type": "string",
"enum": [
"saving_session"
]
},
"phase": {
"anyOf": [
{
"type": "string",
"enum": [
"connecting"
]
},
{
"type": "string",
"enum": [
"waiting_for_cloud"
]
},
{
"type": "string",
"enum": [
"waiting_for_worker"
]
},
{
"type": "string",
"enum": [
"saving_session"
]
}
]
},
"step_path": {
"type": "array",
"items": {
"type": "integer"
}
},
"diagnostics": {
"type": "array",
"items": {
"type": "object",
"required": [
"workflow_id",
"path",
"action",
"repeat",
"attempt",
"started_at",
"duration_ms",
"state"
],
"properties": {
"screenshot": {
"type": "string"
},
"selector": {
"type": "string"
},
"screenshot_omitted": {
"type": "boolean"
},
"workflow_id": {
"type": "string"
},
"path": {
"type": "array",
"items": {
"type": "integer"
}
},
"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"
]
}
]
},
"repeat": {
"type": "integer"
},
"attempt": {
"type": "integer"
},
"started_at": {
"type": "integer"
},
"duration_ms": {
"type": "integer"
},
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"completed"
]
},
{
"type": "string",
"enum": [
"failed"
]
},
{
"type": "string",
"enum": [
"cancelled"
]
},
{
"type": "string",
"enum": [
"control"
]
}
]
},
"error_code": {
"type": "string"
}
}
}
},
"diagnostics_dropped": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
},
"error_code": {
"type": "string"
},
"cleanup_errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"phase",
"message"
],
"properties": {
"phase": {
"type": "string"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"variables": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}