Create workflow
curl --request POST \
--url https://api.cloudcruise.com/workflows \
--header 'Content-Type: application/json' \
--header 'cc-key: <api-key>' \
--data '
{
"name": "<string>",
"nodes": [
{
"id": "<string>",
"name": "<string>",
"parameters": {},
"description": "<string>"
}
],
"edges": {},
"input_schema": {},
"output_schema": {},
"max_retries": 123,
"description": "<string>",
"version_note": "<string>",
"extract_network_urls": [
"<string>"
],
"encrypted_keys": [
"<string>"
],
"popup_xpaths": [
"<string>"
],
"vault_schema": {
"USER": {
"type": "credential",
"domain": "https://example.com",
"example": "11223344-5566-7788-9900-112233445566"
}
},
"enable_popup_handling": true,
"enable_action_timing_recovery": true,
"enable_xpath_recovery": true,
"enable_node_description_enrichment": true,
"run_window": {
"time_zone": "America/Chicago",
"regular_hours": [
{
"active_start_time": {
"hours": 11,
"minutes": 29
},
"active_end_time": {
"hours": 11,
"minutes": 29
}
}
],
"special_hours": [
{
"active": true,
"label": "Thanksgiving",
"recurrence": "FREQ=MONTHLY;BYDAY=1SA"
}
]
},
"enable_error_code_generation": true,
"enable_service_unavailable_recovery": true,
"enable_incorrect_form_input_recovery": true,
"enable_password_update_recovery": true,
"enable_tfa_setup_recovery": true,
"manual_captcha_solve": true,
"allow_requeue": true,
"deny_requeue_past_dry_run_marker": true,
"proxy_setting": "<string>",
"proxy_value": "<string>",
"enable_network_listener": true
}
'import requests
url = "https://api.cloudcruise.com/workflows"
payload = {
"name": "<string>",
"nodes": [
{
"id": "<string>",
"name": "<string>",
"parameters": {},
"description": "<string>"
}
],
"edges": {},
"input_schema": {},
"output_schema": {},
"max_retries": 123,
"description": "<string>",
"version_note": "<string>",
"extract_network_urls": ["<string>"],
"encrypted_keys": ["<string>"],
"popup_xpaths": ["<string>"],
"vault_schema": { "USER": {
"type": "credential",
"domain": "https://example.com",
"example": "11223344-5566-7788-9900-112233445566"
} },
"enable_popup_handling": True,
"enable_action_timing_recovery": True,
"enable_xpath_recovery": True,
"enable_node_description_enrichment": True,
"run_window": {
"time_zone": "America/Chicago",
"regular_hours": [
{
"active_start_time": {
"hours": 11,
"minutes": 29
},
"active_end_time": {
"hours": 11,
"minutes": 29
}
}
],
"special_hours": [
{
"active": True,
"label": "Thanksgiving",
"recurrence": "FREQ=MONTHLY;BYDAY=1SA"
}
]
},
"enable_error_code_generation": True,
"enable_service_unavailable_recovery": True,
"enable_incorrect_form_input_recovery": True,
"enable_password_update_recovery": True,
"enable_tfa_setup_recovery": True,
"manual_captcha_solve": True,
"allow_requeue": True,
"deny_requeue_past_dry_run_marker": True,
"proxy_setting": "<string>",
"proxy_value": "<string>",
"enable_network_listener": True
}
headers = {
"cc-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'cc-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
nodes: [{id: '<string>', name: '<string>', parameters: {}, description: '<string>'}],
edges: {},
input_schema: {},
output_schema: {},
max_retries: 123,
description: '<string>',
version_note: '<string>',
extract_network_urls: ['<string>'],
encrypted_keys: ['<string>'],
popup_xpaths: ['<string>'],
vault_schema: {
USER: {
type: 'credential',
domain: 'https://example.com',
example: '11223344-5566-7788-9900-112233445566'
}
},
enable_popup_handling: true,
enable_action_timing_recovery: true,
enable_xpath_recovery: true,
enable_node_description_enrichment: true,
run_window: {
time_zone: 'America/Chicago',
regular_hours: [
{
active_start_time: {hours: 11, minutes: 29},
active_end_time: {hours: 11, minutes: 29}
}
],
special_hours: [{active: true, label: 'Thanksgiving', recurrence: 'FREQ=MONTHLY;BYDAY=1SA'}]
},
enable_error_code_generation: true,
enable_service_unavailable_recovery: true,
enable_incorrect_form_input_recovery: true,
enable_password_update_recovery: true,
enable_tfa_setup_recovery: true,
manual_captcha_solve: true,
allow_requeue: true,
deny_requeue_past_dry_run_marker: true,
proxy_setting: '<string>',
proxy_value: '<string>',
enable_network_listener: true
})
};
fetch('https://api.cloudcruise.com/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cloudcruise.com/workflows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'nodes' => [
[
'id' => '<string>',
'name' => '<string>',
'parameters' => [
],
'description' => '<string>'
]
],
'edges' => [
],
'input_schema' => [
],
'output_schema' => [
],
'max_retries' => 123,
'description' => '<string>',
'version_note' => '<string>',
'extract_network_urls' => [
'<string>'
],
'encrypted_keys' => [
'<string>'
],
'popup_xpaths' => [
'<string>'
],
'vault_schema' => [
'USER' => [
'type' => 'credential',
'domain' => 'https://example.com',
'example' => '11223344-5566-7788-9900-112233445566'
]
],
'enable_popup_handling' => true,
'enable_action_timing_recovery' => true,
'enable_xpath_recovery' => true,
'enable_node_description_enrichment' => true,
'run_window' => [
'time_zone' => 'America/Chicago',
'regular_hours' => [
[
'active_start_time' => [
'hours' => 11,
'minutes' => 29
],
'active_end_time' => [
'hours' => 11,
'minutes' => 29
]
]
],
'special_hours' => [
[
'active' => true,
'label' => 'Thanksgiving',
'recurrence' => 'FREQ=MONTHLY;BYDAY=1SA'
]
]
],
'enable_error_code_generation' => true,
'enable_service_unavailable_recovery' => true,
'enable_incorrect_form_input_recovery' => true,
'enable_password_update_recovery' => true,
'enable_tfa_setup_recovery' => true,
'manual_captcha_solve' => true,
'allow_requeue' => true,
'deny_requeue_past_dry_run_marker' => true,
'proxy_setting' => '<string>',
'proxy_value' => '<string>',
'enable_network_listener' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"cc-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloudcruise.com/workflows"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"nodes\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {},\n \"description\": \"<string>\"\n }\n ],\n \"edges\": {},\n \"input_schema\": {},\n \"output_schema\": {},\n \"max_retries\": 123,\n \"description\": \"<string>\",\n \"version_note\": \"<string>\",\n \"extract_network_urls\": [\n \"<string>\"\n ],\n \"encrypted_keys\": [\n \"<string>\"\n ],\n \"popup_xpaths\": [\n \"<string>\"\n ],\n \"vault_schema\": {\n \"USER\": {\n \"type\": \"credential\",\n \"domain\": \"https://example.com\",\n \"example\": \"11223344-5566-7788-9900-112233445566\"\n }\n },\n \"enable_popup_handling\": true,\n \"enable_action_timing_recovery\": true,\n \"enable_xpath_recovery\": true,\n \"enable_node_description_enrichment\": true,\n \"run_window\": {\n \"time_zone\": \"America/Chicago\",\n \"regular_hours\": [\n {\n \"active_start_time\": {\n \"hours\": 11,\n \"minutes\": 29\n },\n \"active_end_time\": {\n \"hours\": 11,\n \"minutes\": 29\n }\n }\n ],\n \"special_hours\": [\n {\n \"active\": true,\n \"label\": \"Thanksgiving\",\n \"recurrence\": \"FREQ=MONTHLY;BYDAY=1SA\"\n }\n ]\n },\n \"enable_error_code_generation\": true,\n \"enable_service_unavailable_recovery\": true,\n \"enable_incorrect_form_input_recovery\": true,\n \"enable_password_update_recovery\": true,\n \"enable_tfa_setup_recovery\": true,\n \"manual_captcha_solve\": true,\n \"allow_requeue\": true,\n \"deny_requeue_past_dry_run_marker\": true,\n \"proxy_setting\": \"<string>\",\n \"proxy_value\": \"<string>\",\n \"enable_network_listener\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cc-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cloudcruise.com/workflows")
.header("cc-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"nodes\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {},\n \"description\": \"<string>\"\n }\n ],\n \"edges\": {},\n \"input_schema\": {},\n \"output_schema\": {},\n \"max_retries\": 123,\n \"description\": \"<string>\",\n \"version_note\": \"<string>\",\n \"extract_network_urls\": [\n \"<string>\"\n ],\n \"encrypted_keys\": [\n \"<string>\"\n ],\n \"popup_xpaths\": [\n \"<string>\"\n ],\n \"vault_schema\": {\n \"USER\": {\n \"type\": \"credential\",\n \"domain\": \"https://example.com\",\n \"example\": \"11223344-5566-7788-9900-112233445566\"\n }\n },\n \"enable_popup_handling\": true,\n \"enable_action_timing_recovery\": true,\n \"enable_xpath_recovery\": true,\n \"enable_node_description_enrichment\": true,\n \"run_window\": {\n \"time_zone\": \"America/Chicago\",\n \"regular_hours\": [\n {\n \"active_start_time\": {\n \"hours\": 11,\n \"minutes\": 29\n },\n \"active_end_time\": {\n \"hours\": 11,\n \"minutes\": 29\n }\n }\n ],\n \"special_hours\": [\n {\n \"active\": true,\n \"label\": \"Thanksgiving\",\n \"recurrence\": \"FREQ=MONTHLY;BYDAY=1SA\"\n }\n ]\n },\n \"enable_error_code_generation\": true,\n \"enable_service_unavailable_recovery\": true,\n \"enable_incorrect_form_input_recovery\": true,\n \"enable_password_update_recovery\": true,\n \"enable_tfa_setup_recovery\": true,\n \"manual_captcha_solve\": true,\n \"allow_requeue\": true,\n \"deny_requeue_past_dry_run_marker\": true,\n \"proxy_setting\": \"<string>\",\n \"proxy_value\": \"<string>\",\n \"enable_network_listener\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudcruise.com/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cc-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"nodes\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {},\n \"description\": \"<string>\"\n }\n ],\n \"edges\": {},\n \"input_schema\": {},\n \"output_schema\": {},\n \"max_retries\": 123,\n \"description\": \"<string>\",\n \"version_note\": \"<string>\",\n \"extract_network_urls\": [\n \"<string>\"\n ],\n \"encrypted_keys\": [\n \"<string>\"\n ],\n \"popup_xpaths\": [\n \"<string>\"\n ],\n \"vault_schema\": {\n \"USER\": {\n \"type\": \"credential\",\n \"domain\": \"https://example.com\",\n \"example\": \"11223344-5566-7788-9900-112233445566\"\n }\n },\n \"enable_popup_handling\": true,\n \"enable_action_timing_recovery\": true,\n \"enable_xpath_recovery\": true,\n \"enable_node_description_enrichment\": true,\n \"run_window\": {\n \"time_zone\": \"America/Chicago\",\n \"regular_hours\": [\n {\n \"active_start_time\": {\n \"hours\": 11,\n \"minutes\": 29\n },\n \"active_end_time\": {\n \"hours\": 11,\n \"minutes\": 29\n }\n }\n ],\n \"special_hours\": [\n {\n \"active\": true,\n \"label\": \"Thanksgiving\",\n \"recurrence\": \"FREQ=MONTHLY;BYDAY=1SA\"\n }\n ]\n },\n \"enable_error_code_generation\": true,\n \"enable_service_unavailable_recovery\": true,\n \"enable_incorrect_form_input_recovery\": true,\n \"enable_password_update_recovery\": true,\n \"enable_tfa_setup_recovery\": true,\n \"manual_captcha_solve\": true,\n \"allow_requeue\": true,\n \"deny_requeue_past_dry_run_marker\": true,\n \"proxy_setting\": \"<string>\",\n \"proxy_value\": \"<string>\",\n \"enable_network_listener\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nodes": [
{}
],
"edges": {},
"description": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "2.1.0",
"major": 123,
"minor": 123,
"patch": 123,
"bump_type": "major",
"branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"default_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merge_parent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input_schema": {},
"vault_schema": {},
"enable_popup_handling": true,
"enable_xpath_recovery": true,
"enable_node_description_enrichment": true,
"run_window": {
"time_zone": "America/Chicago",
"regular_hours": [
{
"active_start_day": "MONDAY",
"active_start_time": {
"hours": 11,
"minutes": 29
},
"active_end_day": "MONDAY",
"active_end_time": {
"hours": 11,
"minutes": 29
}
}
],
"special_hours": [
{
"active": true,
"label": "Thanksgiving",
"start_date": {
"year": 123,
"month": 6,
"day": 16
},
"end_date": {
"year": 123,
"month": 6,
"day": 16
},
"recurrence": "FREQ=MONTHLY;BYDAY=1SA",
"recurrence_start": {
"year": 123,
"month": 6,
"day": 16
},
"active_start_time": {
"hours": 11,
"minutes": 29
},
"active_end_time": {
"hours": 11,
"minutes": 29
}
}
]
},
"enable_error_code_generation": true,
"enable_service_unavailable_recovery": true,
"enable_incorrect_form_input_recovery": true,
"enable_password_update_recovery": true,
"enable_tfa_setup_recovery": true,
"manual_captcha_solve": true,
"allow_requeue": true,
"deny_requeue_past_dry_run_marker": true,
"enable_action_timing_recovery": true,
"enable_network_listener": true
}Workflow API
Create workflow
Creates a new workflow in the workspace associated with your API key.
The workflow ID is generated server-side. The response includes the full workflow definition with the assigned ID, which you can use for subsequent operations (e.g., starting runs, updating the workflow).
Versioning: The initial creation produces the workflow’s first version, tagged with a semantic version (e.g. 1.0.0), on its default branch main. Use PUT /workflows/{workflow_id} to create subsequent versions.
Read-only fields: A body returned by GET /workflows/{workflow_id} or GET /workflows/{workflow_id}/export is accepted unchanged. Its read-only fields are handled as follows:
id(orworkflow_id): used as the new workflow’s ID if it is free. A taken ID returns409 WORKFLOW_ID_TAKEN.workspace_id: may be omitted ornull. If sent, it must be your workspace, otherwise409 READ_ONLY_FIELD_CONFLICT.version_id,version,major,minor,patch,bump_type,branch_id,default_branch_id,parent_version_id,merge_parent_version_id,generation,created_at,created_by,updated_at,conversation_id: ignored. The server assigns them.error_codes: copied into your workspace likePOST /workflows/importdoes. Error codes with the same name and description are reused.
POST
/
workflows
Create workflow
curl --request POST \
--url https://api.cloudcruise.com/workflows \
--header 'Content-Type: application/json' \
--header 'cc-key: <api-key>' \
--data '
{
"name": "<string>",
"nodes": [
{
"id": "<string>",
"name": "<string>",
"parameters": {},
"description": "<string>"
}
],
"edges": {},
"input_schema": {},
"output_schema": {},
"max_retries": 123,
"description": "<string>",
"version_note": "<string>",
"extract_network_urls": [
"<string>"
],
"encrypted_keys": [
"<string>"
],
"popup_xpaths": [
"<string>"
],
"vault_schema": {
"USER": {
"type": "credential",
"domain": "https://example.com",
"example": "11223344-5566-7788-9900-112233445566"
}
},
"enable_popup_handling": true,
"enable_action_timing_recovery": true,
"enable_xpath_recovery": true,
"enable_node_description_enrichment": true,
"run_window": {
"time_zone": "America/Chicago",
"regular_hours": [
{
"active_start_time": {
"hours": 11,
"minutes": 29
},
"active_end_time": {
"hours": 11,
"minutes": 29
}
}
],
"special_hours": [
{
"active": true,
"label": "Thanksgiving",
"recurrence": "FREQ=MONTHLY;BYDAY=1SA"
}
]
},
"enable_error_code_generation": true,
"enable_service_unavailable_recovery": true,
"enable_incorrect_form_input_recovery": true,
"enable_password_update_recovery": true,
"enable_tfa_setup_recovery": true,
"manual_captcha_solve": true,
"allow_requeue": true,
"deny_requeue_past_dry_run_marker": true,
"proxy_setting": "<string>",
"proxy_value": "<string>",
"enable_network_listener": true
}
'import requests
url = "https://api.cloudcruise.com/workflows"
payload = {
"name": "<string>",
"nodes": [
{
"id": "<string>",
"name": "<string>",
"parameters": {},
"description": "<string>"
}
],
"edges": {},
"input_schema": {},
"output_schema": {},
"max_retries": 123,
"description": "<string>",
"version_note": "<string>",
"extract_network_urls": ["<string>"],
"encrypted_keys": ["<string>"],
"popup_xpaths": ["<string>"],
"vault_schema": { "USER": {
"type": "credential",
"domain": "https://example.com",
"example": "11223344-5566-7788-9900-112233445566"
} },
"enable_popup_handling": True,
"enable_action_timing_recovery": True,
"enable_xpath_recovery": True,
"enable_node_description_enrichment": True,
"run_window": {
"time_zone": "America/Chicago",
"regular_hours": [
{
"active_start_time": {
"hours": 11,
"minutes": 29
},
"active_end_time": {
"hours": 11,
"minutes": 29
}
}
],
"special_hours": [
{
"active": True,
"label": "Thanksgiving",
"recurrence": "FREQ=MONTHLY;BYDAY=1SA"
}
]
},
"enable_error_code_generation": True,
"enable_service_unavailable_recovery": True,
"enable_incorrect_form_input_recovery": True,
"enable_password_update_recovery": True,
"enable_tfa_setup_recovery": True,
"manual_captcha_solve": True,
"allow_requeue": True,
"deny_requeue_past_dry_run_marker": True,
"proxy_setting": "<string>",
"proxy_value": "<string>",
"enable_network_listener": True
}
headers = {
"cc-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'cc-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
nodes: [{id: '<string>', name: '<string>', parameters: {}, description: '<string>'}],
edges: {},
input_schema: {},
output_schema: {},
max_retries: 123,
description: '<string>',
version_note: '<string>',
extract_network_urls: ['<string>'],
encrypted_keys: ['<string>'],
popup_xpaths: ['<string>'],
vault_schema: {
USER: {
type: 'credential',
domain: 'https://example.com',
example: '11223344-5566-7788-9900-112233445566'
}
},
enable_popup_handling: true,
enable_action_timing_recovery: true,
enable_xpath_recovery: true,
enable_node_description_enrichment: true,
run_window: {
time_zone: 'America/Chicago',
regular_hours: [
{
active_start_time: {hours: 11, minutes: 29},
active_end_time: {hours: 11, minutes: 29}
}
],
special_hours: [{active: true, label: 'Thanksgiving', recurrence: 'FREQ=MONTHLY;BYDAY=1SA'}]
},
enable_error_code_generation: true,
enable_service_unavailable_recovery: true,
enable_incorrect_form_input_recovery: true,
enable_password_update_recovery: true,
enable_tfa_setup_recovery: true,
manual_captcha_solve: true,
allow_requeue: true,
deny_requeue_past_dry_run_marker: true,
proxy_setting: '<string>',
proxy_value: '<string>',
enable_network_listener: true
})
};
fetch('https://api.cloudcruise.com/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cloudcruise.com/workflows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'nodes' => [
[
'id' => '<string>',
'name' => '<string>',
'parameters' => [
],
'description' => '<string>'
]
],
'edges' => [
],
'input_schema' => [
],
'output_schema' => [
],
'max_retries' => 123,
'description' => '<string>',
'version_note' => '<string>',
'extract_network_urls' => [
'<string>'
],
'encrypted_keys' => [
'<string>'
],
'popup_xpaths' => [
'<string>'
],
'vault_schema' => [
'USER' => [
'type' => 'credential',
'domain' => 'https://example.com',
'example' => '11223344-5566-7788-9900-112233445566'
]
],
'enable_popup_handling' => true,
'enable_action_timing_recovery' => true,
'enable_xpath_recovery' => true,
'enable_node_description_enrichment' => true,
'run_window' => [
'time_zone' => 'America/Chicago',
'regular_hours' => [
[
'active_start_time' => [
'hours' => 11,
'minutes' => 29
],
'active_end_time' => [
'hours' => 11,
'minutes' => 29
]
]
],
'special_hours' => [
[
'active' => true,
'label' => 'Thanksgiving',
'recurrence' => 'FREQ=MONTHLY;BYDAY=1SA'
]
]
],
'enable_error_code_generation' => true,
'enable_service_unavailable_recovery' => true,
'enable_incorrect_form_input_recovery' => true,
'enable_password_update_recovery' => true,
'enable_tfa_setup_recovery' => true,
'manual_captcha_solve' => true,
'allow_requeue' => true,
'deny_requeue_past_dry_run_marker' => true,
'proxy_setting' => '<string>',
'proxy_value' => '<string>',
'enable_network_listener' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"cc-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloudcruise.com/workflows"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"nodes\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {},\n \"description\": \"<string>\"\n }\n ],\n \"edges\": {},\n \"input_schema\": {},\n \"output_schema\": {},\n \"max_retries\": 123,\n \"description\": \"<string>\",\n \"version_note\": \"<string>\",\n \"extract_network_urls\": [\n \"<string>\"\n ],\n \"encrypted_keys\": [\n \"<string>\"\n ],\n \"popup_xpaths\": [\n \"<string>\"\n ],\n \"vault_schema\": {\n \"USER\": {\n \"type\": \"credential\",\n \"domain\": \"https://example.com\",\n \"example\": \"11223344-5566-7788-9900-112233445566\"\n }\n },\n \"enable_popup_handling\": true,\n \"enable_action_timing_recovery\": true,\n \"enable_xpath_recovery\": true,\n \"enable_node_description_enrichment\": true,\n \"run_window\": {\n \"time_zone\": \"America/Chicago\",\n \"regular_hours\": [\n {\n \"active_start_time\": {\n \"hours\": 11,\n \"minutes\": 29\n },\n \"active_end_time\": {\n \"hours\": 11,\n \"minutes\": 29\n }\n }\n ],\n \"special_hours\": [\n {\n \"active\": true,\n \"label\": \"Thanksgiving\",\n \"recurrence\": \"FREQ=MONTHLY;BYDAY=1SA\"\n }\n ]\n },\n \"enable_error_code_generation\": true,\n \"enable_service_unavailable_recovery\": true,\n \"enable_incorrect_form_input_recovery\": true,\n \"enable_password_update_recovery\": true,\n \"enable_tfa_setup_recovery\": true,\n \"manual_captcha_solve\": true,\n \"allow_requeue\": true,\n \"deny_requeue_past_dry_run_marker\": true,\n \"proxy_setting\": \"<string>\",\n \"proxy_value\": \"<string>\",\n \"enable_network_listener\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cc-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cloudcruise.com/workflows")
.header("cc-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"nodes\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {},\n \"description\": \"<string>\"\n }\n ],\n \"edges\": {},\n \"input_schema\": {},\n \"output_schema\": {},\n \"max_retries\": 123,\n \"description\": \"<string>\",\n \"version_note\": \"<string>\",\n \"extract_network_urls\": [\n \"<string>\"\n ],\n \"encrypted_keys\": [\n \"<string>\"\n ],\n \"popup_xpaths\": [\n \"<string>\"\n ],\n \"vault_schema\": {\n \"USER\": {\n \"type\": \"credential\",\n \"domain\": \"https://example.com\",\n \"example\": \"11223344-5566-7788-9900-112233445566\"\n }\n },\n \"enable_popup_handling\": true,\n \"enable_action_timing_recovery\": true,\n \"enable_xpath_recovery\": true,\n \"enable_node_description_enrichment\": true,\n \"run_window\": {\n \"time_zone\": \"America/Chicago\",\n \"regular_hours\": [\n {\n \"active_start_time\": {\n \"hours\": 11,\n \"minutes\": 29\n },\n \"active_end_time\": {\n \"hours\": 11,\n \"minutes\": 29\n }\n }\n ],\n \"special_hours\": [\n {\n \"active\": true,\n \"label\": \"Thanksgiving\",\n \"recurrence\": \"FREQ=MONTHLY;BYDAY=1SA\"\n }\n ]\n },\n \"enable_error_code_generation\": true,\n \"enable_service_unavailable_recovery\": true,\n \"enable_incorrect_form_input_recovery\": true,\n \"enable_password_update_recovery\": true,\n \"enable_tfa_setup_recovery\": true,\n \"manual_captcha_solve\": true,\n \"allow_requeue\": true,\n \"deny_requeue_past_dry_run_marker\": true,\n \"proxy_setting\": \"<string>\",\n \"proxy_value\": \"<string>\",\n \"enable_network_listener\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudcruise.com/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cc-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"nodes\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {},\n \"description\": \"<string>\"\n }\n ],\n \"edges\": {},\n \"input_schema\": {},\n \"output_schema\": {},\n \"max_retries\": 123,\n \"description\": \"<string>\",\n \"version_note\": \"<string>\",\n \"extract_network_urls\": [\n \"<string>\"\n ],\n \"encrypted_keys\": [\n \"<string>\"\n ],\n \"popup_xpaths\": [\n \"<string>\"\n ],\n \"vault_schema\": {\n \"USER\": {\n \"type\": \"credential\",\n \"domain\": \"https://example.com\",\n \"example\": \"11223344-5566-7788-9900-112233445566\"\n }\n },\n \"enable_popup_handling\": true,\n \"enable_action_timing_recovery\": true,\n \"enable_xpath_recovery\": true,\n \"enable_node_description_enrichment\": true,\n \"run_window\": {\n \"time_zone\": \"America/Chicago\",\n \"regular_hours\": [\n {\n \"active_start_time\": {\n \"hours\": 11,\n \"minutes\": 29\n },\n \"active_end_time\": {\n \"hours\": 11,\n \"minutes\": 29\n }\n }\n ],\n \"special_hours\": [\n {\n \"active\": true,\n \"label\": \"Thanksgiving\",\n \"recurrence\": \"FREQ=MONTHLY;BYDAY=1SA\"\n }\n ]\n },\n \"enable_error_code_generation\": true,\n \"enable_service_unavailable_recovery\": true,\n \"enable_incorrect_form_input_recovery\": true,\n \"enable_password_update_recovery\": true,\n \"enable_tfa_setup_recovery\": true,\n \"manual_captcha_solve\": true,\n \"allow_requeue\": true,\n \"deny_requeue_past_dry_run_marker\": true,\n \"proxy_setting\": \"<string>\",\n \"proxy_value\": \"<string>\",\n \"enable_network_listener\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nodes": [
{}
],
"edges": {},
"description": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "2.1.0",
"major": 123,
"minor": 123,
"patch": 123,
"bump_type": "major",
"branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"default_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merge_parent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input_schema": {},
"vault_schema": {},
"enable_popup_handling": true,
"enable_xpath_recovery": true,
"enable_node_description_enrichment": true,
"run_window": {
"time_zone": "America/Chicago",
"regular_hours": [
{
"active_start_day": "MONDAY",
"active_start_time": {
"hours": 11,
"minutes": 29
},
"active_end_day": "MONDAY",
"active_end_time": {
"hours": 11,
"minutes": 29
}
}
],
"special_hours": [
{
"active": true,
"label": "Thanksgiving",
"start_date": {
"year": 123,
"month": 6,
"day": 16
},
"end_date": {
"year": 123,
"month": 6,
"day": 16
},
"recurrence": "FREQ=MONTHLY;BYDAY=1SA",
"recurrence_start": {
"year": 123,
"month": 6,
"day": 16
},
"active_start_time": {
"hours": 11,
"minutes": 29
},
"active_end_time": {
"hours": 11,
"minutes": 29
}
}
]
},
"enable_error_code_generation": true,
"enable_service_unavailable_recovery": true,
"enable_incorrect_form_input_recovery": true,
"enable_password_update_recovery": true,
"enable_tfa_setup_recovery": true,
"manual_captcha_solve": true,
"allow_requeue": true,
"deny_requeue_past_dry_run_marker": true,
"enable_action_timing_recovery": true,
"enable_network_listener": true
}Authorizations
API key-based authentication. Provide your CloudCruise API key in the cc-key header.
Headers
CloudCruise API key for authentication
Body
application/json
Payload for creating a new workflow via POST. The workflow ID is generated server-side.
Display name of the workflow
Array of workflow step nodes
Show child attributes
Show child attributes
Map of edges connecting workflow nodes
Show child attributes
Show child attributes
JSON Schema defining the workflow's input variables
Selects which fields the run returns in its result and webhook payload. Only the fields named under properties are returned; pass an empty object {} to return the whole run context instead, excluding the run's inputs. A schema that names no properties - {"type": "object", "properties": {}} - is stored and applied as {}.
Maximum number of retry attempts for failed workflow steps
Optional description of the workflow
Optional note describing this version
URL patterns to extract from network traffic during execution
References to encrypted vault keys used by this workflow
XPath selectors for popups that should be automatically dismissed
Schema defining vault credentials required by this workflow
Show child attributes
Show child attributes
Example:
{
"USER": {
"type": "credential",
"domain": "https://example.com",
"example": "11223344-5566-7788-9900-112233445566"
}
}
Whether automatic popup handling is enabled
Whether action timing recovery is enabled
Whether automatic XPath recovery is enabled
Whether node descriptions are auto-enriched for reliability improvements
Run window for the workflow. Leave it out on save to keep the current one, send null to remove it. See Run Window.
Show child attributes
Show child attributes
Whether automatic error code generation is enabled
Whether service unavailable recovery is enabled
Deprecated, no effect
Whether password update recovery is enabled. When a site forces a password change, the Maintenance Agent classifies the error and sends a notification.
Deprecated, no effect
When true, captchas are solved only at CAPTCHA nodes. When false, the automatic solver also runs before each step that acts on the page. A new workflow created without this field gets true. Existing workflows keep their stored value.
Whether automatic retries are enabled for this workflow. When false, the workflow will not be automatically retried on transient failures regardless of other recovery settings.
When the workflow has a dry-run marker (end_here_on_dry_run), restricts automatic retries to failures that occur before the marker. Only effective when allow_requeue is true. Defaults to true.
Proxy configuration setting
Proxy value
Whether the network listener is enabled
Response
Workflow created successfully
Full workflow definition including nodes and edges
Unique identifier for the workflow
Name of the workflow
Timestamp when the workflow was created
ID of the workspace this workflow belongs to
ID of the user who created the workflow
Array of workflow step nodes
Map of edges connecting workflow nodes
Show child attributes
Show child attributes
Description of the workflow
Timestamp when the workflow was last updated
ID of the current workflow version
Semantic version (major.minor.patch) of this version
Example:
"2.1.0"
Major part of version
Minor part of version
Patch part of version
How version was derived from its parent, or null when it was chosen explicitly or has no parent
Available options:
major, minor, patch Branch this version was saved to
The workflow's default branch, used by runs and reads that name no branch
The version this one was saved on top of
For a merge, the head of the branch that was merged in
JSON schema defining the workflow's input variables
Schema defining vault credentials and their configuration
Whether popup handling is enabled for this workflow
Whether XPath recovery is enabled for this workflow
Whether node descriptions are auto-enriched for reliability improvements
Run window for the workflow. Leave it out on save to keep the current one, send null to remove it. See Run Window.
Show child attributes
Show child attributes
Whether error code generation is enabled for this workflow
Whether service unavailable recovery is enabled for this workflow
Deprecated, no effect
Whether password update recovery is enabled. When a site forces a password change, the Maintenance Agent classifies the error and sends a notification.
Deprecated, no effect
When true, captchas are solved only at CAPTCHA nodes. When false, the automatic solver also runs before each step that acts on the page. A new workflow created without this field gets true. Existing workflows keep their stored value.
Whether automatic retries are enabled for this workflow. When false, the workflow will not be automatically retried on transient failures regardless of other recovery settings.
When the workflow has a dry-run marker (end_here_on_dry_run), restricts automatic retries to failures that occur before the marker. Only effective when allow_requeue is true. Defaults to true.
Whether action timing recovery is enabled
Whether network listener capture is enabled for this workflow version
Was this page helpful?