Create a new agent
curl --request POST \
--url https://api.skyvern.com/v1/agents \
--header 'Content-Type: application/json' \
--data '
{
"json_definition": {
"title": "<string>",
"workflow_definition": {
"parameters": [
{
"key": "<string>",
"aws_key": "<string>",
"parameter_type": "aws_secret",
"description": "<string>"
}
],
"blocks": [
{
"label": "<string>",
"block_type": "task",
"next_block_label": "<string>",
"continue_on_failure": false,
"model": {},
"ignore_workflow_system_prompt": false,
"next_loop_on_failure": false,
"url": "<string>",
"title": "",
"engine": "skyvern-1.0",
"navigation_goal": "<string>",
"data_extraction_goal": "<string>",
"data_schema": {},
"error_code_mapping": {},
"max_retries": 0,
"max_steps_per_run": 123,
"parameter_keys": [
"<string>"
],
"complete_on_download": false,
"download_suffix": "<string>",
"totp_verification_url": "<string>",
"totp_identifier": "<string>",
"disable_cache": false,
"complete_criterion": "<string>",
"terminate_criterion": "<string>",
"complete_verification": true,
"include_action_history_in_verification": false
}
],
"version": 123,
"finally_block_label": "<string>",
"error_code_mapping": {},
"workflow_system_prompt": "<string>"
},
"description": "<string>",
"webhook_callback_url": "<string>",
"totp_verification_url": "<string>",
"totp_identifier": "<string>",
"persist_browser_session": false,
"pin_saved_session_ip": false,
"browser_profile_id": "<string>",
"browser_profile_key": "<string>",
"model": {},
"is_saved_task": false,
"max_screenshot_scrolls": 123,
"max_elapsed_time_minutes": 240,
"extra_http_headers": {},
"cdp_connect_headers": {},
"status": "published",
"run_with": "agent",
"ai_fallback": true,
"cache_key": "default",
"adaptive_caching": false,
"enable_self_healing": true,
"code_version": 1,
"generate_script_on_terminal": false,
"run_sequentially": false,
"sequential_key": "<string>",
"folder_id": "<string>"
},
"yaml_definition": "<string>"
}
'import requests
url = "https://api.skyvern.com/v1/agents"
payload = {
"json_definition": {
"title": "<string>",
"workflow_definition": {
"parameters": [
{
"key": "<string>",
"aws_key": "<string>",
"parameter_type": "aws_secret",
"description": "<string>"
}
],
"blocks": [
{
"label": "<string>",
"block_type": "task",
"next_block_label": "<string>",
"continue_on_failure": False,
"model": {},
"ignore_workflow_system_prompt": False,
"next_loop_on_failure": False,
"url": "<string>",
"title": "",
"engine": "skyvern-1.0",
"navigation_goal": "<string>",
"data_extraction_goal": "<string>",
"data_schema": {},
"error_code_mapping": {},
"max_retries": 0,
"max_steps_per_run": 123,
"parameter_keys": ["<string>"],
"complete_on_download": False,
"download_suffix": "<string>",
"totp_verification_url": "<string>",
"totp_identifier": "<string>",
"disable_cache": False,
"complete_criterion": "<string>",
"terminate_criterion": "<string>",
"complete_verification": True,
"include_action_history_in_verification": False
}
],
"version": 123,
"finally_block_label": "<string>",
"error_code_mapping": {},
"workflow_system_prompt": "<string>"
},
"description": "<string>",
"webhook_callback_url": "<string>",
"totp_verification_url": "<string>",
"totp_identifier": "<string>",
"persist_browser_session": False,
"pin_saved_session_ip": False,
"browser_profile_id": "<string>",
"browser_profile_key": "<string>",
"model": {},
"is_saved_task": False,
"max_screenshot_scrolls": 123,
"max_elapsed_time_minutes": 240,
"extra_http_headers": {},
"cdp_connect_headers": {},
"status": "published",
"run_with": "agent",
"ai_fallback": True,
"cache_key": "default",
"adaptive_caching": False,
"enable_self_healing": True,
"code_version": 1,
"generate_script_on_terminal": False,
"run_sequentially": False,
"sequential_key": "<string>",
"folder_id": "<string>"
},
"yaml_definition": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
json_definition: {
title: '<string>',
workflow_definition: {
parameters: [
{
key: '<string>',
aws_key: '<string>',
parameter_type: 'aws_secret',
description: '<string>'
}
],
blocks: [
{
label: '<string>',
block_type: 'task',
next_block_label: '<string>',
continue_on_failure: false,
model: {},
ignore_workflow_system_prompt: false,
next_loop_on_failure: false,
url: '<string>',
title: '',
engine: 'skyvern-1.0',
navigation_goal: '<string>',
data_extraction_goal: '<string>',
data_schema: {},
error_code_mapping: {},
max_retries: 0,
max_steps_per_run: 123,
parameter_keys: ['<string>'],
complete_on_download: false,
download_suffix: '<string>',
totp_verification_url: '<string>',
totp_identifier: '<string>',
disable_cache: false,
complete_criterion: '<string>',
terminate_criterion: '<string>',
complete_verification: true,
include_action_history_in_verification: false
}
],
version: 123,
finally_block_label: '<string>',
error_code_mapping: {},
workflow_system_prompt: '<string>'
},
description: '<string>',
webhook_callback_url: '<string>',
totp_verification_url: '<string>',
totp_identifier: '<string>',
persist_browser_session: false,
pin_saved_session_ip: false,
browser_profile_id: '<string>',
browser_profile_key: '<string>',
model: {},
is_saved_task: false,
max_screenshot_scrolls: 123,
max_elapsed_time_minutes: 240,
extra_http_headers: {},
cdp_connect_headers: {},
status: 'published',
run_with: 'agent',
ai_fallback: true,
cache_key: 'default',
adaptive_caching: false,
enable_self_healing: true,
code_version: 1,
generate_script_on_terminal: false,
run_sequentially: false,
sequential_key: '<string>',
folder_id: '<string>'
},
yaml_definition: '<string>'
})
};
fetch('https://api.skyvern.com/v1/agents', 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.skyvern.com/v1/agents",
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([
'json_definition' => [
'title' => '<string>',
'workflow_definition' => [
'parameters' => [
[
'key' => '<string>',
'aws_key' => '<string>',
'parameter_type' => 'aws_secret',
'description' => '<string>'
]
],
'blocks' => [
[
'label' => '<string>',
'block_type' => 'task',
'next_block_label' => '<string>',
'continue_on_failure' => false,
'model' => [
],
'ignore_workflow_system_prompt' => false,
'next_loop_on_failure' => false,
'url' => '<string>',
'title' => '',
'engine' => 'skyvern-1.0',
'navigation_goal' => '<string>',
'data_extraction_goal' => '<string>',
'data_schema' => [
],
'error_code_mapping' => [
],
'max_retries' => 0,
'max_steps_per_run' => 123,
'parameter_keys' => [
'<string>'
],
'complete_on_download' => false,
'download_suffix' => '<string>',
'totp_verification_url' => '<string>',
'totp_identifier' => '<string>',
'disable_cache' => false,
'complete_criterion' => '<string>',
'terminate_criterion' => '<string>',
'complete_verification' => true,
'include_action_history_in_verification' => false
]
],
'version' => 123,
'finally_block_label' => '<string>',
'error_code_mapping' => [
],
'workflow_system_prompt' => '<string>'
],
'description' => '<string>',
'webhook_callback_url' => '<string>',
'totp_verification_url' => '<string>',
'totp_identifier' => '<string>',
'persist_browser_session' => false,
'pin_saved_session_ip' => false,
'browser_profile_id' => '<string>',
'browser_profile_key' => '<string>',
'model' => [
],
'is_saved_task' => false,
'max_screenshot_scrolls' => 123,
'max_elapsed_time_minutes' => 240,
'extra_http_headers' => [
],
'cdp_connect_headers' => [
],
'status' => 'published',
'run_with' => 'agent',
'ai_fallback' => true,
'cache_key' => 'default',
'adaptive_caching' => false,
'enable_self_healing' => true,
'code_version' => 1,
'generate_script_on_terminal' => false,
'run_sequentially' => false,
'sequential_key' => '<string>',
'folder_id' => '<string>'
],
'yaml_definition' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.skyvern.com/v1/agents"
payload := strings.NewReader("{\n \"json_definition\": {\n \"title\": \"<string>\",\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"<string>\",\n \"aws_key\": \"<string>\",\n \"parameter_type\": \"aws_secret\",\n \"description\": \"<string>\"\n }\n ],\n \"blocks\": [\n {\n \"label\": \"<string>\",\n \"block_type\": \"task\",\n \"next_block_label\": \"<string>\",\n \"continue_on_failure\": false,\n \"model\": {},\n \"ignore_workflow_system_prompt\": false,\n \"next_loop_on_failure\": false,\n \"url\": \"<string>\",\n \"title\": \"\",\n \"engine\": \"skyvern-1.0\",\n \"navigation_goal\": \"<string>\",\n \"data_extraction_goal\": \"<string>\",\n \"data_schema\": {},\n \"error_code_mapping\": {},\n \"max_retries\": 0,\n \"max_steps_per_run\": 123,\n \"parameter_keys\": [\n \"<string>\"\n ],\n \"complete_on_download\": false,\n \"download_suffix\": \"<string>\",\n \"totp_verification_url\": \"<string>\",\n \"totp_identifier\": \"<string>\",\n \"disable_cache\": false,\n \"complete_criterion\": \"<string>\",\n \"terminate_criterion\": \"<string>\",\n \"complete_verification\": true,\n \"include_action_history_in_verification\": false\n }\n ],\n \"version\": 123,\n \"finally_block_label\": \"<string>\",\n \"error_code_mapping\": {},\n \"workflow_system_prompt\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"webhook_callback_url\": \"<string>\",\n \"totp_verification_url\": \"<string>\",\n \"totp_identifier\": \"<string>\",\n \"persist_browser_session\": false,\n \"pin_saved_session_ip\": false,\n \"browser_profile_id\": \"<string>\",\n \"browser_profile_key\": \"<string>\",\n \"model\": {},\n \"is_saved_task\": false,\n \"max_screenshot_scrolls\": 123,\n \"max_elapsed_time_minutes\": 240,\n \"extra_http_headers\": {},\n \"cdp_connect_headers\": {},\n \"status\": \"published\",\n \"run_with\": \"agent\",\n \"ai_fallback\": true,\n \"cache_key\": \"default\",\n \"adaptive_caching\": false,\n \"enable_self_healing\": true,\n \"code_version\": 1,\n \"generate_script_on_terminal\": false,\n \"run_sequentially\": false,\n \"sequential_key\": \"<string>\",\n \"folder_id\": \"<string>\"\n },\n \"yaml_definition\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.skyvern.com/v1/agents")
.header("Content-Type", "application/json")
.body("{\n \"json_definition\": {\n \"title\": \"<string>\",\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"<string>\",\n \"aws_key\": \"<string>\",\n \"parameter_type\": \"aws_secret\",\n \"description\": \"<string>\"\n }\n ],\n \"blocks\": [\n {\n \"label\": \"<string>\",\n \"block_type\": \"task\",\n \"next_block_label\": \"<string>\",\n \"continue_on_failure\": false,\n \"model\": {},\n \"ignore_workflow_system_prompt\": false,\n \"next_loop_on_failure\": false,\n \"url\": \"<string>\",\n \"title\": \"\",\n \"engine\": \"skyvern-1.0\",\n \"navigation_goal\": \"<string>\",\n \"data_extraction_goal\": \"<string>\",\n \"data_schema\": {},\n \"error_code_mapping\": {},\n \"max_retries\": 0,\n \"max_steps_per_run\": 123,\n \"parameter_keys\": [\n \"<string>\"\n ],\n \"complete_on_download\": false,\n \"download_suffix\": \"<string>\",\n \"totp_verification_url\": \"<string>\",\n \"totp_identifier\": \"<string>\",\n \"disable_cache\": false,\n \"complete_criterion\": \"<string>\",\n \"terminate_criterion\": \"<string>\",\n \"complete_verification\": true,\n \"include_action_history_in_verification\": false\n }\n ],\n \"version\": 123,\n \"finally_block_label\": \"<string>\",\n \"error_code_mapping\": {},\n \"workflow_system_prompt\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"webhook_callback_url\": \"<string>\",\n \"totp_verification_url\": \"<string>\",\n \"totp_identifier\": \"<string>\",\n \"persist_browser_session\": false,\n \"pin_saved_session_ip\": false,\n \"browser_profile_id\": \"<string>\",\n \"browser_profile_key\": \"<string>\",\n \"model\": {},\n \"is_saved_task\": false,\n \"max_screenshot_scrolls\": 123,\n \"max_elapsed_time_minutes\": 240,\n \"extra_http_headers\": {},\n \"cdp_connect_headers\": {},\n \"status\": \"published\",\n \"run_with\": \"agent\",\n \"ai_fallback\": true,\n \"cache_key\": \"default\",\n \"adaptive_caching\": false,\n \"enable_self_healing\": true,\n \"code_version\": 1,\n \"generate_script_on_terminal\": false,\n \"run_sequentially\": false,\n \"sequential_key\": \"<string>\",\n \"folder_id\": \"<string>\"\n },\n \"yaml_definition\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.skyvern.com/v1/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"json_definition\": {\n \"title\": \"<string>\",\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"<string>\",\n \"aws_key\": \"<string>\",\n \"parameter_type\": \"aws_secret\",\n \"description\": \"<string>\"\n }\n ],\n \"blocks\": [\n {\n \"label\": \"<string>\",\n \"block_type\": \"task\",\n \"next_block_label\": \"<string>\",\n \"continue_on_failure\": false,\n \"model\": {},\n \"ignore_workflow_system_prompt\": false,\n \"next_loop_on_failure\": false,\n \"url\": \"<string>\",\n \"title\": \"\",\n \"engine\": \"skyvern-1.0\",\n \"navigation_goal\": \"<string>\",\n \"data_extraction_goal\": \"<string>\",\n \"data_schema\": {},\n \"error_code_mapping\": {},\n \"max_retries\": 0,\n \"max_steps_per_run\": 123,\n \"parameter_keys\": [\n \"<string>\"\n ],\n \"complete_on_download\": false,\n \"download_suffix\": \"<string>\",\n \"totp_verification_url\": \"<string>\",\n \"totp_identifier\": \"<string>\",\n \"disable_cache\": false,\n \"complete_criterion\": \"<string>\",\n \"terminate_criterion\": \"<string>\",\n \"complete_verification\": true,\n \"include_action_history_in_verification\": false\n }\n ],\n \"version\": 123,\n \"finally_block_label\": \"<string>\",\n \"error_code_mapping\": {},\n \"workflow_system_prompt\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"webhook_callback_url\": \"<string>\",\n \"totp_verification_url\": \"<string>\",\n \"totp_identifier\": \"<string>\",\n \"persist_browser_session\": false,\n \"pin_saved_session_ip\": false,\n \"browser_profile_id\": \"<string>\",\n \"browser_profile_key\": \"<string>\",\n \"model\": {},\n \"is_saved_task\": false,\n \"max_screenshot_scrolls\": 123,\n \"max_elapsed_time_minutes\": 240,\n \"extra_http_headers\": {},\n \"cdp_connect_headers\": {},\n \"status\": \"published\",\n \"run_with\": \"agent\",\n \"ai_fallback\": true,\n \"cache_key\": \"default\",\n \"adaptive_caching\": false,\n \"enable_self_healing\": true,\n \"code_version\": 1,\n \"generate_script_on_terminal\": false,\n \"run_sequentially\": false,\n \"sequential_key\": \"<string>\",\n \"folder_id\": \"<string>\"\n },\n \"yaml_definition\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"workflow_id": "<string>",
"organization_id": "<string>",
"title": "<string>",
"workflow_permanent_id": "<string>",
"version": 123,
"is_saved_task": true,
"workflow_definition": {
"parameters": [
{
"key": "<string>",
"workflow_parameter_id": "<string>",
"workflow_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"parameter_type": "workflow",
"description": "<string>",
"default_value": "<string>",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"blocks": [
{
"label": "<string>",
"output_parameter": {
"key": "<string>",
"output_parameter_id": "<string>",
"workflow_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"parameter_type": "output",
"description": "<string>",
"deleted_at": "2023-11-07T05:31:56Z"
},
"next_block_label": "<string>",
"block_type": "conditional",
"continue_on_failure": false,
"model": {},
"disable_cache": false,
"ignore_workflow_system_prompt": false,
"next_loop_on_failure": false,
"branch_conditions": [
{
"id": "<string>",
"criteria": {
"expression": "<string>",
"criteria_type": "jinja2_template",
"description": "<string>"
},
"next_block_label": "<string>",
"description": "<string>",
"is_default": false
}
]
}
],
"version": 1,
"finally_block_label": "<string>",
"error_code_mapping": {},
"workflow_system_prompt": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"agent_id": "<string>",
"is_template": false,
"description": "<string>",
"webhook_callback_url": "<string>",
"totp_verification_url": "<string>",
"totp_identifier": "<string>",
"persist_browser_session": false,
"pin_saved_session_ip": false,
"browser_profile_id": "<string>",
"browser_profile_key": "<string>",
"model": {},
"status": "published",
"max_screenshot_scrolls": 123,
"max_elapsed_time_minutes": 123,
"extra_http_headers": {},
"cdp_connect_headers": {},
"run_with": "agent",
"ai_fallback": true,
"cache_key": "<string>",
"adaptive_caching": false,
"enable_self_healing": false,
"code_version": 123,
"generate_script_on_terminal": false,
"run_sequentially": true,
"sequential_key": "<string>",
"folder_id": "<string>",
"import_error": "<string>",
"created_by": "<string>",
"edited_by": "<string>",
"copilot_authored": false,
"deleted_at": "2023-11-07T05:31:56Z"
}Agents
Create a new agent
Create a new agent
POST
/
v1
/
agents
Create a new agent
curl --request POST \
--url https://api.skyvern.com/v1/agents \
--header 'Content-Type: application/json' \
--data '
{
"json_definition": {
"title": "<string>",
"workflow_definition": {
"parameters": [
{
"key": "<string>",
"aws_key": "<string>",
"parameter_type": "aws_secret",
"description": "<string>"
}
],
"blocks": [
{
"label": "<string>",
"block_type": "task",
"next_block_label": "<string>",
"continue_on_failure": false,
"model": {},
"ignore_workflow_system_prompt": false,
"next_loop_on_failure": false,
"url": "<string>",
"title": "",
"engine": "skyvern-1.0",
"navigation_goal": "<string>",
"data_extraction_goal": "<string>",
"data_schema": {},
"error_code_mapping": {},
"max_retries": 0,
"max_steps_per_run": 123,
"parameter_keys": [
"<string>"
],
"complete_on_download": false,
"download_suffix": "<string>",
"totp_verification_url": "<string>",
"totp_identifier": "<string>",
"disable_cache": false,
"complete_criterion": "<string>",
"terminate_criterion": "<string>",
"complete_verification": true,
"include_action_history_in_verification": false
}
],
"version": 123,
"finally_block_label": "<string>",
"error_code_mapping": {},
"workflow_system_prompt": "<string>"
},
"description": "<string>",
"webhook_callback_url": "<string>",
"totp_verification_url": "<string>",
"totp_identifier": "<string>",
"persist_browser_session": false,
"pin_saved_session_ip": false,
"browser_profile_id": "<string>",
"browser_profile_key": "<string>",
"model": {},
"is_saved_task": false,
"max_screenshot_scrolls": 123,
"max_elapsed_time_minutes": 240,
"extra_http_headers": {},
"cdp_connect_headers": {},
"status": "published",
"run_with": "agent",
"ai_fallback": true,
"cache_key": "default",
"adaptive_caching": false,
"enable_self_healing": true,
"code_version": 1,
"generate_script_on_terminal": false,
"run_sequentially": false,
"sequential_key": "<string>",
"folder_id": "<string>"
},
"yaml_definition": "<string>"
}
'import requests
url = "https://api.skyvern.com/v1/agents"
payload = {
"json_definition": {
"title": "<string>",
"workflow_definition": {
"parameters": [
{
"key": "<string>",
"aws_key": "<string>",
"parameter_type": "aws_secret",
"description": "<string>"
}
],
"blocks": [
{
"label": "<string>",
"block_type": "task",
"next_block_label": "<string>",
"continue_on_failure": False,
"model": {},
"ignore_workflow_system_prompt": False,
"next_loop_on_failure": False,
"url": "<string>",
"title": "",
"engine": "skyvern-1.0",
"navigation_goal": "<string>",
"data_extraction_goal": "<string>",
"data_schema": {},
"error_code_mapping": {},
"max_retries": 0,
"max_steps_per_run": 123,
"parameter_keys": ["<string>"],
"complete_on_download": False,
"download_suffix": "<string>",
"totp_verification_url": "<string>",
"totp_identifier": "<string>",
"disable_cache": False,
"complete_criterion": "<string>",
"terminate_criterion": "<string>",
"complete_verification": True,
"include_action_history_in_verification": False
}
],
"version": 123,
"finally_block_label": "<string>",
"error_code_mapping": {},
"workflow_system_prompt": "<string>"
},
"description": "<string>",
"webhook_callback_url": "<string>",
"totp_verification_url": "<string>",
"totp_identifier": "<string>",
"persist_browser_session": False,
"pin_saved_session_ip": False,
"browser_profile_id": "<string>",
"browser_profile_key": "<string>",
"model": {},
"is_saved_task": False,
"max_screenshot_scrolls": 123,
"max_elapsed_time_minutes": 240,
"extra_http_headers": {},
"cdp_connect_headers": {},
"status": "published",
"run_with": "agent",
"ai_fallback": True,
"cache_key": "default",
"adaptive_caching": False,
"enable_self_healing": True,
"code_version": 1,
"generate_script_on_terminal": False,
"run_sequentially": False,
"sequential_key": "<string>",
"folder_id": "<string>"
},
"yaml_definition": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
json_definition: {
title: '<string>',
workflow_definition: {
parameters: [
{
key: '<string>',
aws_key: '<string>',
parameter_type: 'aws_secret',
description: '<string>'
}
],
blocks: [
{
label: '<string>',
block_type: 'task',
next_block_label: '<string>',
continue_on_failure: false,
model: {},
ignore_workflow_system_prompt: false,
next_loop_on_failure: false,
url: '<string>',
title: '',
engine: 'skyvern-1.0',
navigation_goal: '<string>',
data_extraction_goal: '<string>',
data_schema: {},
error_code_mapping: {},
max_retries: 0,
max_steps_per_run: 123,
parameter_keys: ['<string>'],
complete_on_download: false,
download_suffix: '<string>',
totp_verification_url: '<string>',
totp_identifier: '<string>',
disable_cache: false,
complete_criterion: '<string>',
terminate_criterion: '<string>',
complete_verification: true,
include_action_history_in_verification: false
}
],
version: 123,
finally_block_label: '<string>',
error_code_mapping: {},
workflow_system_prompt: '<string>'
},
description: '<string>',
webhook_callback_url: '<string>',
totp_verification_url: '<string>',
totp_identifier: '<string>',
persist_browser_session: false,
pin_saved_session_ip: false,
browser_profile_id: '<string>',
browser_profile_key: '<string>',
model: {},
is_saved_task: false,
max_screenshot_scrolls: 123,
max_elapsed_time_minutes: 240,
extra_http_headers: {},
cdp_connect_headers: {},
status: 'published',
run_with: 'agent',
ai_fallback: true,
cache_key: 'default',
adaptive_caching: false,
enable_self_healing: true,
code_version: 1,
generate_script_on_terminal: false,
run_sequentially: false,
sequential_key: '<string>',
folder_id: '<string>'
},
yaml_definition: '<string>'
})
};
fetch('https://api.skyvern.com/v1/agents', 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.skyvern.com/v1/agents",
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([
'json_definition' => [
'title' => '<string>',
'workflow_definition' => [
'parameters' => [
[
'key' => '<string>',
'aws_key' => '<string>',
'parameter_type' => 'aws_secret',
'description' => '<string>'
]
],
'blocks' => [
[
'label' => '<string>',
'block_type' => 'task',
'next_block_label' => '<string>',
'continue_on_failure' => false,
'model' => [
],
'ignore_workflow_system_prompt' => false,
'next_loop_on_failure' => false,
'url' => '<string>',
'title' => '',
'engine' => 'skyvern-1.0',
'navigation_goal' => '<string>',
'data_extraction_goal' => '<string>',
'data_schema' => [
],
'error_code_mapping' => [
],
'max_retries' => 0,
'max_steps_per_run' => 123,
'parameter_keys' => [
'<string>'
],
'complete_on_download' => false,
'download_suffix' => '<string>',
'totp_verification_url' => '<string>',
'totp_identifier' => '<string>',
'disable_cache' => false,
'complete_criterion' => '<string>',
'terminate_criterion' => '<string>',
'complete_verification' => true,
'include_action_history_in_verification' => false
]
],
'version' => 123,
'finally_block_label' => '<string>',
'error_code_mapping' => [
],
'workflow_system_prompt' => '<string>'
],
'description' => '<string>',
'webhook_callback_url' => '<string>',
'totp_verification_url' => '<string>',
'totp_identifier' => '<string>',
'persist_browser_session' => false,
'pin_saved_session_ip' => false,
'browser_profile_id' => '<string>',
'browser_profile_key' => '<string>',
'model' => [
],
'is_saved_task' => false,
'max_screenshot_scrolls' => 123,
'max_elapsed_time_minutes' => 240,
'extra_http_headers' => [
],
'cdp_connect_headers' => [
],
'status' => 'published',
'run_with' => 'agent',
'ai_fallback' => true,
'cache_key' => 'default',
'adaptive_caching' => false,
'enable_self_healing' => true,
'code_version' => 1,
'generate_script_on_terminal' => false,
'run_sequentially' => false,
'sequential_key' => '<string>',
'folder_id' => '<string>'
],
'yaml_definition' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.skyvern.com/v1/agents"
payload := strings.NewReader("{\n \"json_definition\": {\n \"title\": \"<string>\",\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"<string>\",\n \"aws_key\": \"<string>\",\n \"parameter_type\": \"aws_secret\",\n \"description\": \"<string>\"\n }\n ],\n \"blocks\": [\n {\n \"label\": \"<string>\",\n \"block_type\": \"task\",\n \"next_block_label\": \"<string>\",\n \"continue_on_failure\": false,\n \"model\": {},\n \"ignore_workflow_system_prompt\": false,\n \"next_loop_on_failure\": false,\n \"url\": \"<string>\",\n \"title\": \"\",\n \"engine\": \"skyvern-1.0\",\n \"navigation_goal\": \"<string>\",\n \"data_extraction_goal\": \"<string>\",\n \"data_schema\": {},\n \"error_code_mapping\": {},\n \"max_retries\": 0,\n \"max_steps_per_run\": 123,\n \"parameter_keys\": [\n \"<string>\"\n ],\n \"complete_on_download\": false,\n \"download_suffix\": \"<string>\",\n \"totp_verification_url\": \"<string>\",\n \"totp_identifier\": \"<string>\",\n \"disable_cache\": false,\n \"complete_criterion\": \"<string>\",\n \"terminate_criterion\": \"<string>\",\n \"complete_verification\": true,\n \"include_action_history_in_verification\": false\n }\n ],\n \"version\": 123,\n \"finally_block_label\": \"<string>\",\n \"error_code_mapping\": {},\n \"workflow_system_prompt\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"webhook_callback_url\": \"<string>\",\n \"totp_verification_url\": \"<string>\",\n \"totp_identifier\": \"<string>\",\n \"persist_browser_session\": false,\n \"pin_saved_session_ip\": false,\n \"browser_profile_id\": \"<string>\",\n \"browser_profile_key\": \"<string>\",\n \"model\": {},\n \"is_saved_task\": false,\n \"max_screenshot_scrolls\": 123,\n \"max_elapsed_time_minutes\": 240,\n \"extra_http_headers\": {},\n \"cdp_connect_headers\": {},\n \"status\": \"published\",\n \"run_with\": \"agent\",\n \"ai_fallback\": true,\n \"cache_key\": \"default\",\n \"adaptive_caching\": false,\n \"enable_self_healing\": true,\n \"code_version\": 1,\n \"generate_script_on_terminal\": false,\n \"run_sequentially\": false,\n \"sequential_key\": \"<string>\",\n \"folder_id\": \"<string>\"\n },\n \"yaml_definition\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.skyvern.com/v1/agents")
.header("Content-Type", "application/json")
.body("{\n \"json_definition\": {\n \"title\": \"<string>\",\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"<string>\",\n \"aws_key\": \"<string>\",\n \"parameter_type\": \"aws_secret\",\n \"description\": \"<string>\"\n }\n ],\n \"blocks\": [\n {\n \"label\": \"<string>\",\n \"block_type\": \"task\",\n \"next_block_label\": \"<string>\",\n \"continue_on_failure\": false,\n \"model\": {},\n \"ignore_workflow_system_prompt\": false,\n \"next_loop_on_failure\": false,\n \"url\": \"<string>\",\n \"title\": \"\",\n \"engine\": \"skyvern-1.0\",\n \"navigation_goal\": \"<string>\",\n \"data_extraction_goal\": \"<string>\",\n \"data_schema\": {},\n \"error_code_mapping\": {},\n \"max_retries\": 0,\n \"max_steps_per_run\": 123,\n \"parameter_keys\": [\n \"<string>\"\n ],\n \"complete_on_download\": false,\n \"download_suffix\": \"<string>\",\n \"totp_verification_url\": \"<string>\",\n \"totp_identifier\": \"<string>\",\n \"disable_cache\": false,\n \"complete_criterion\": \"<string>\",\n \"terminate_criterion\": \"<string>\",\n \"complete_verification\": true,\n \"include_action_history_in_verification\": false\n }\n ],\n \"version\": 123,\n \"finally_block_label\": \"<string>\",\n \"error_code_mapping\": {},\n \"workflow_system_prompt\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"webhook_callback_url\": \"<string>\",\n \"totp_verification_url\": \"<string>\",\n \"totp_identifier\": \"<string>\",\n \"persist_browser_session\": false,\n \"pin_saved_session_ip\": false,\n \"browser_profile_id\": \"<string>\",\n \"browser_profile_key\": \"<string>\",\n \"model\": {},\n \"is_saved_task\": false,\n \"max_screenshot_scrolls\": 123,\n \"max_elapsed_time_minutes\": 240,\n \"extra_http_headers\": {},\n \"cdp_connect_headers\": {},\n \"status\": \"published\",\n \"run_with\": \"agent\",\n \"ai_fallback\": true,\n \"cache_key\": \"default\",\n \"adaptive_caching\": false,\n \"enable_self_healing\": true,\n \"code_version\": 1,\n \"generate_script_on_terminal\": false,\n \"run_sequentially\": false,\n \"sequential_key\": \"<string>\",\n \"folder_id\": \"<string>\"\n },\n \"yaml_definition\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.skyvern.com/v1/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"json_definition\": {\n \"title\": \"<string>\",\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"<string>\",\n \"aws_key\": \"<string>\",\n \"parameter_type\": \"aws_secret\",\n \"description\": \"<string>\"\n }\n ],\n \"blocks\": [\n {\n \"label\": \"<string>\",\n \"block_type\": \"task\",\n \"next_block_label\": \"<string>\",\n \"continue_on_failure\": false,\n \"model\": {},\n \"ignore_workflow_system_prompt\": false,\n \"next_loop_on_failure\": false,\n \"url\": \"<string>\",\n \"title\": \"\",\n \"engine\": \"skyvern-1.0\",\n \"navigation_goal\": \"<string>\",\n \"data_extraction_goal\": \"<string>\",\n \"data_schema\": {},\n \"error_code_mapping\": {},\n \"max_retries\": 0,\n \"max_steps_per_run\": 123,\n \"parameter_keys\": [\n \"<string>\"\n ],\n \"complete_on_download\": false,\n \"download_suffix\": \"<string>\",\n \"totp_verification_url\": \"<string>\",\n \"totp_identifier\": \"<string>\",\n \"disable_cache\": false,\n \"complete_criterion\": \"<string>\",\n \"terminate_criterion\": \"<string>\",\n \"complete_verification\": true,\n \"include_action_history_in_verification\": false\n }\n ],\n \"version\": 123,\n \"finally_block_label\": \"<string>\",\n \"error_code_mapping\": {},\n \"workflow_system_prompt\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"webhook_callback_url\": \"<string>\",\n \"totp_verification_url\": \"<string>\",\n \"totp_identifier\": \"<string>\",\n \"persist_browser_session\": false,\n \"pin_saved_session_ip\": false,\n \"browser_profile_id\": \"<string>\",\n \"browser_profile_key\": \"<string>\",\n \"model\": {},\n \"is_saved_task\": false,\n \"max_screenshot_scrolls\": 123,\n \"max_elapsed_time_minutes\": 240,\n \"extra_http_headers\": {},\n \"cdp_connect_headers\": {},\n \"status\": \"published\",\n \"run_with\": \"agent\",\n \"ai_fallback\": true,\n \"cache_key\": \"default\",\n \"adaptive_caching\": false,\n \"enable_self_healing\": true,\n \"code_version\": 1,\n \"generate_script_on_terminal\": false,\n \"run_sequentially\": false,\n \"sequential_key\": \"<string>\",\n \"folder_id\": \"<string>\"\n },\n \"yaml_definition\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"workflow_id": "<string>",
"organization_id": "<string>",
"title": "<string>",
"workflow_permanent_id": "<string>",
"version": 123,
"is_saved_task": true,
"workflow_definition": {
"parameters": [
{
"key": "<string>",
"workflow_parameter_id": "<string>",
"workflow_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"parameter_type": "workflow",
"description": "<string>",
"default_value": "<string>",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"blocks": [
{
"label": "<string>",
"output_parameter": {
"key": "<string>",
"output_parameter_id": "<string>",
"workflow_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"parameter_type": "output",
"description": "<string>",
"deleted_at": "2023-11-07T05:31:56Z"
},
"next_block_label": "<string>",
"block_type": "conditional",
"continue_on_failure": false,
"model": {},
"disable_cache": false,
"ignore_workflow_system_prompt": false,
"next_loop_on_failure": false,
"branch_conditions": [
{
"id": "<string>",
"criteria": {
"expression": "<string>",
"criteria_type": "jinja2_template",
"description": "<string>"
},
"next_block_label": "<string>",
"description": "<string>",
"is_default": false
}
]
}
],
"version": 1,
"finally_block_label": "<string>",
"error_code_mapping": {},
"workflow_system_prompt": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"agent_id": "<string>",
"is_template": false,
"description": "<string>",
"webhook_callback_url": "<string>",
"totp_verification_url": "<string>",
"totp_identifier": "<string>",
"persist_browser_session": false,
"pin_saved_session_ip": false,
"browser_profile_id": "<string>",
"browser_profile_key": "<string>",
"model": {},
"status": "published",
"max_screenshot_scrolls": 123,
"max_elapsed_time_minutes": 123,
"extra_http_headers": {},
"cdp_connect_headers": {},
"run_with": "agent",
"ai_fallback": true,
"cache_key": "<string>",
"adaptive_caching": false,
"enable_self_healing": false,
"code_version": 123,
"generate_script_on_terminal": false,
"run_sequentially": true,
"sequential_key": "<string>",
"folder_id": "<string>",
"import_error": "<string>",
"created_by": "<string>",
"edited_by": "<string>",
"copilot_authored": false,
"deleted_at": "2023-11-07T05:31:56Z"
}Headers
Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.
Query Parameters
Optional folder ID to assign the workflow to
Body
application/json
Response
Successfully created agent
Show child attributes
Show child attributes
Alias of workflow_permanent_id — the stable agent identifier (starts with wpid_).
Available options:
RESIDENTIAL, US-CA, US-NY, US-TX, US-FL, US-WA, RESIDENTIAL_ES, RESIDENTIAL_IE, RESIDENTIAL_GB, RESIDENTIAL_IN, RESIDENTIAL_JP, RESIDENTIAL_FR, RESIDENTIAL_DE, RESIDENTIAL_NZ, RESIDENTIAL_ZA, RESIDENTIAL_AR, RESIDENTIAL_AU, RESIDENTIAL_BR, RESIDENTIAL_TR, RESIDENTIAL_CA, RESIDENTIAL_MX, RESIDENTIAL_IT, RESIDENTIAL_NL, RESIDENTIAL_PH, RESIDENTIAL_KR, RESIDENTIAL_SA, RESIDENTIAL_ISP, NONE Available options:
published, draft, auto_generated, importing, import_failed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I

