Skip to main content
POST
Update an agent

Headers

x-api-key
string | null

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Path Parameters

workflow_id
string
required

The ID of the agent to update. Starts with wpid_.

Example:

"wpid_123"

Body

application/json
json_definition
WorkflowCreateYAMLRequest · object | null

Workflow definition in JSON format

yaml_definition
string | null

Workflow definition in YAML format

Response

Successfully updated agent

workflow_id
string
required
organization_id
string
required
title
string
required
workflow_permanent_id
string
required
version
integer
required
is_saved_task
boolean
required
workflow_definition
WorkflowDefinition · object
required
created_at
string<date-time>
required
modified_at
string<date-time>
required
agent_id
string
required
read-only

Alias of workflow_permanent_id — the stable agent identifier (starts with wpid_).

is_template
boolean
default:false
description
string | null
proxy_location
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
webhook_callback_url
string | null
totp_verification_url
string | null
totp_identifier
string | null
persist_browser_session
boolean
default:false
pin_saved_session_ip
boolean
default:false
browser_profile_id
string | null
browser_profile_key
string | null
model
Model · object | null
status
enum<string>
default:published
Available options:
published,
draft,
auto_generated,
importing,
import_failed
max_screenshot_scrolls
integer | null
max_elapsed_time_minutes
integer | null
extra_http_headers
Extra Http Headers · object | null
cdp_connect_headers
Cdp Connect Headers · object | null
run_with
string
default:agent
ai_fallback
boolean
default:true
cache_key
string | null
adaptive_caching
boolean
default:false
enable_self_healing
boolean
default:false
code_version
integer | null
generate_script_on_terminal
boolean
default:false
run_sequentially
boolean | null
sequential_key
string | null
folder_id
string | null
import_error
string | null
created_by
string | null
edited_by
string | null
copilot_authored
boolean
default:false
deleted_at
string<date-time> | null