Skyvern: Agents schemas (part 4)

← Agents operations · All schemas

Update an agent — response body — workflow definition blocks item block type while loop

Field	Type	Presence	Description and constraints
$	object	Root	Loop block driven by a runtime condition. Iterates while ``condition`` evaluates truthy. Top-of-loop semantics: the condition is evaluated *before* each iteration (including the first). If the condition is false on the first check, the body never runs and the block returns success with an empty output list. Safety: the loop is capped at ``DEFAULT_MAX_LOOP_ITERATIONS`` (1000). Reaching the cap is treated as a failure so that a misbehaving condition can never spin forever.
block_type	string	Required within parent	Must equal: while_loop Default: while_loop
condition	JSON	Required within parent
condition (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type while loop condition criteria type jinja2 template
condition (anyOf 2)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type while loop condition criteria type prompt
continue_on_failure	boolean	Optional	Default: false
disable_cache	boolean	Optional	Default: false
ignore_workflow_system_prompt	boolean	Optional	Default: false
label	string	Required within parent	Author-facing identifier for a block; unique within a workflow.
loop_blocks	array	Required within parent
loop_blocks[]	JSON	Each item
loop_blocks[] (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type conditional
loop_blocks[] (anyOf 2)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type for loop
loop_blocks[] (anyOf 3)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type while loop
loop_blocks[] (anyOf 4)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type task
loop_blocks[] (anyOf 5)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type code
loop_blocks[] (anyOf 6)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type text prompt
loop_blocks[] (anyOf 7)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type download to s3
loop_blocks[] (anyOf 8)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type upload to s3
loop_blocks[] (anyOf 9)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type send_email, body_format: text, html
loop_blocks[] (anyOf 10)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type file_url_parser, file_type: auto detect, csv, excel, pdf, image, docx, zip
loop_blocks[] (anyOf 11)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type pdf parser
loop_blocks[] (anyOf 12)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type validation
loop_blocks[] (anyOf 13)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / ai_fallback: fallback, proactive, block type action
loop_blocks[] (anyOf 14)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type navigation
loop_blocks[] (anyOf 15)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type extraction
loop_blocks[] (anyOf 16)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type login
loop_blocks[] (anyOf 17)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type wait
loop_blocks[] (anyOf 18)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type human_interaction, body_format: text, html
loop_blocks[] (anyOf 19)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type file_download, download_target: website, s3, azure, google drive, sftp
loop_blocks[] (anyOf 20)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type goto url
loop_blocks[] (anyOf 21)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type task v2
loop_blocks[] (anyOf 22)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type file_upload, storage_type: s3, azure, google drive, sftp
loop_blocks[] (anyOf 23)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type http request
loop_blocks[] (anyOf 24)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type web_search, provider: auto, google, exa
loop_blocks[] (anyOf 25)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type print page
loop_blocks[] (anyOf 26)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type workflow trigger
loop_blocks[] (anyOf 27)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type google sheets read
loop_blocks[] (anyOf 28)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type email_inbox, email_client: gmail, outlook
loop_blocks[] (anyOf 29)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type google_sheets_write, write_mode: append, update
loop_blocks[] (anyOf 30)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type powerbi query
loop_blocks[] (anyOf 31)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type pdf fill
loop_blocks[] (anyOf 32)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type split pdf
loop_blocks[] (anyOf 33)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type data export
loop_blocks[] (anyOf 34)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type terminate
loop_blocks[] (anyOf 35)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type agent step
model	JSON	Optional
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
next_block_label	JSON	Optional	Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
output_parameter	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type output

Referenced models: Update an agent — response body — workflow definition blocks item block type download to s3, Update an agent — response body — workflow definition blocks item block type while loop condition criteria type jinja2 template, Update an agent — response body — workflow_definition / blocks / item / ai_fallback: fallback, proactive, block type action, Update an agent — response body — workflow definition blocks item block type agent step, Update an agent — response body — workflow definition blocks item block type code, Update an agent — response body — workflow definition blocks item block type conditional, Update an agent — response body — workflow definition blocks item block type data export, Update an agent — response body — workflow_definition / blocks / item / block_type email_inbox, email_client: gmail, outlook, Update an agent — response body — workflow definition blocks item block type extraction, Update an agent — response body — workflow_definition / blocks / item / block_type file_download, download_target: website, s3, azure, google drive, sftp, Update an agent — response body — workflow_definition / blocks / item / block_type file_url_parser, file_type: auto detect, csv, excel, pdf, image, docx, zip, Update an agent — response body — workflow_definition / blocks / item / block_type file_upload, storage_type: s3, azure, google drive, sftp, Update an agent — response body — workflow definition blocks item block type for loop, Update an agent — response body — workflow definition blocks item block type google sheets read, Update an agent — response body — workflow_definition / blocks / item / block_type google_sheets_write, write_mode: append, update, Update an agent — response body — workflow definition blocks item block type http request, Update an agent — response body — workflow_definition / blocks / item / block_type human_interaction, body_format: text, html, Update an agent — response body — workflow definition blocks item block type login, Update an agent — response body — workflow definition blocks item block type navigation, Update an agent — response body — workflow definition parameters item parameter type output, Update an agent — response body — workflow definition blocks item block type pdf parser, Update an agent — response body — workflow definition blocks item block type pdf fill, Update an agent — response body — workflow definition blocks item block type powerbi query, Update an agent — response body — workflow definition blocks item block type print page, Update an agent — response body — workflow definition blocks item block type while loop condition criteria type prompt, Update an agent — response body — workflow_definition / blocks / item / block_type send_email, body_format: text, html, Update an agent — response body — workflow definition blocks item block type split pdf, Update an agent — response body — workflow definition blocks item block type task, Update an agent — response body — workflow definition blocks item block type task v2, Update an agent — response body — workflow definition blocks item block type terminate, Update an agent — response body — workflow definition blocks item block type text prompt, Update an agent — response body — workflow definition blocks item block type upload to s3, Update an agent — response body — workflow definition blocks item block type goto url, Update an agent — response body — workflow definition blocks item block type validation, Update an agent — response body — workflow definition blocks item block type wait, Update an agent — response body — workflow_definition / blocks / item / block_type web_search, provider: auto, google, exa, Update an agent — response body — workflow definition blocks item block type while loop, Update an agent — response body — workflow definition blocks item block type workflow trigger

Update an agent — response body — workflow definition blocks item block type while loop condition criteria type jinja2 template

Field	Type	Presence	Description and constraints
$	object	Root	Jinja2-templated branch criteria (only supported criteria type for now).
criteria_type	string	Required within parent	Must equal: jinja2_template Default: jinja2_template
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
expression	string	Required within parent

Update an agent — response body — workflow definition blocks item block type while loop condition criteria type prompt

Field	Type	Presence	Description and constraints
$	object	Root	Natural language branch criteria.
criteria_type	string	Required within parent	Must equal: prompt Default: prompt
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
expression	string	Required within parent

Update an agent — response body — workflow definition blocks item block type workflow trigger

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: workflow_trigger Default: workflow_trigger
browser_session_id	JSON	Optional
browser_session_id (anyOf 1)	string	Alternative
browser_session_id (anyOf 2)	null	Alternative
continue_on_failure	boolean	Optional	Default: false
disable_cache	boolean	Optional	Default: false
ignore_workflow_system_prompt	boolean	Optional	Default: false
label	string	Required within parent	Author-facing identifier for a block; unique within a workflow.
model	JSON	Optional
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
next_block_label	JSON	Optional	Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
output_parameter	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters	array	Optional	Default: []
parameters[]	JSON	Each item
parameters[] (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id
parameters[] (anyOf 2)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type credential
payload	JSON	Optional
payload (anyOf 1)	object	Alternative	Additional keys: allowed
payload (anyOf 2)	null	Alternative
use_parent_browser_session	boolean	Optional	Default: false
wait_for_completion	boolean	Optional	Default: true
workflow_permanent_id	string	Required within parent

Referenced models: Update an agent — response body — workflow definition parameters item parameter type aws secret, Update an agent — response body — workflow definition parameters item parameter type azure secret, Update an agent — response body — workflow definition parameters item parameter type azure vault credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data, Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information, Update an agent — response body — workflow definition parameters item parameter type credential, Update an agent — response body — workflow definition parameters item parameter type onepassword, Update an agent — response body — workflow definition parameters item parameter type context, Update an agent — response body — workflow definition parameters item parameter type output, Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id

Update an agent — response body — workflow definition parameters item parameter type aws secret

Field	Type	Presence	Description and constraints
$	object	Root
aws_key	string	Required within parent
aws_secret_parameter_id	string	Required within parent
created_at	string	Required within parent	Format: date-time
deleted_at	JSON	Optional
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
key	string	Required within parent
modified_at	string	Required within parent	Format: date-time
parameter_type	string	Required within parent	Must equal: aws_secret Default: aws_secret
workflow_id	string	Required within parent

Update an agent — response body — workflow definition parameters item parameter type azure secret

Field	Type	Presence	Description and constraints
$	object	Root
azure_key	string	Required within parent
azure_secret_parameter_id	string	Required within parent
created_at	string	Required within parent	Format: date-time
deleted_at	JSON	Optional
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
key	string	Required within parent
modified_at	string	Required within parent	Format: date-time
parameter_type	string	Required within parent	Must equal: azure_secret Default: azure_secret
workflow_id	string	Required within parent

Update an agent — response body — workflow definition parameters item parameter type azure vault credential

Field	Type	Presence	Description and constraints
$	object	Root
azure_vault_credential_parameter_id	string	Required within parent
created_at	string	Required within parent	Format: date-time
deleted_at	JSON	Optional
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
key	string	Required within parent
modified_at	string	Required within parent	Format: date-time
parameter_type	string	Required within parent	Must equal: azure_vault_credential Default: azure_vault_credential
password_key	string	Required within parent
totp_secret_key	JSON	Optional
totp_secret_key (anyOf 1)	string	Alternative
totp_secret_key (anyOf 2)	null	Alternative
username_key	string	Required within parent
vault_name	string	Required within parent
workflow_id	string	Required within parent

Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data

Field	Type	Presence	Description and constraints
$	object	Root
bitwarden_client_id_aws_secret_key	string	Required within parent
bitwarden_client_secret_aws_secret_key	string	Required within parent
bitwarden_collection_id	string	Required within parent
bitwarden_credit_card_data_parameter_id	string	Required within parent
bitwarden_item_id	string	Required within parent
bitwarden_master_password_aws_secret_key	string	Required within parent
created_at	string	Required within parent	Format: date-time
deleted_at	JSON	Optional
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
key	string	Required within parent
modified_at	string	Required within parent	Format: date-time
parameter_type	string	Required within parent	Must equal: bitwarden_credit_card_data Default: bitwarden_credit_card_data
workflow_id	string	Required within parent

Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential

Field	Type	Presence	Description and constraints
$	object	Root
bitwarden_client_id_aws_secret_key	string	Required within parent
bitwarden_client_secret_aws_secret_key	string	Required within parent
bitwarden_collection_id	JSON	Optional
bitwarden_collection_id (anyOf 1)	string	Alternative
bitwarden_collection_id (anyOf 2)	null	Alternative
bitwarden_item_id	JSON	Optional
bitwarden_item_id (anyOf 1)	string	Alternative
bitwarden_item_id (anyOf 2)	null	Alternative
bitwarden_login_credential_parameter_id	string	Required within parent
bitwarden_master_password_aws_secret_key	string	Required within parent
created_at	string	Required within parent	Format: date-time
deleted_at	JSON	Optional
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
key	string	Required within parent
modified_at	string	Required within parent	Format: date-time
parameter_type	string	Required within parent	Must equal: bitwarden_login_credential Default: bitwarden_login_credential
totp_identifier	JSON	Optional
totp_identifier (anyOf 1)	string	Alternative
totp_identifier (anyOf 2)	null	Alternative
url_parameter_key	JSON	Optional
url_parameter_key (anyOf 1)	string	Alternative
url_parameter_key (anyOf 2)	null	Alternative
workflow_id	string	Required within parent

Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information

Field	Type	Presence	Description and constraints
$	object	Root
bitwarden_client_id_aws_secret_key	string	Required within parent
bitwarden_client_secret_aws_secret_key	string	Required within parent
bitwarden_collection_id	string	Required within parent
bitwarden_identity_fields	array	Required within parent
bitwarden_identity_fields[]	string	Each item
bitwarden_identity_key	string	Required within parent
bitwarden_master_password_aws_secret_key	string	Required within parent
bitwarden_sensitive_information_parameter_id	string	Required within parent
created_at	string	Required within parent	Format: date-time
deleted_at	JSON	Optional
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
key	string	Required within parent
modified_at	string	Required within parent	Format: date-time
parameter_type	string	Required within parent	Must equal: bitwarden_sensitive_information Default: bitwarden_sensitive_information
workflow_id	string	Required within parent

Update an agent — response body — workflow definition parameters item parameter type context

Field	Type	Presence	Description and constraints
$	object	Root
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
key	string	Required within parent
parameter_type	string	Required within parent	Must equal: context Default: context
source	JSON	Required within parent
source (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id
source (anyOf 2)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type context
source (anyOf 3)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type aws secret
source (anyOf 4)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure secret
source (anyOf 5)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
source (anyOf 6)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
source (anyOf 7)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
source (anyOf 8)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type onepassword
source (anyOf 9)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
source (anyOf 10)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type output
source (anyOf 11)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type credential
value	JSON	Optional
value (anyOf 1)	string	Alternative
value (anyOf 2)	JSON	Alternative
value (anyOf 2) (anyOf 1)	integer	Alternative
value (anyOf 2) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value (anyOf 3)	JSON	Alternative
value (anyOf 3) (anyOf 1)	number	Alternative
value (anyOf 3) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value (anyOf 4)	boolean	Alternative
value (anyOf 5)	object	Alternative	Additional keys: allowed
value (anyOf 6)	array	Alternative
value (anyOf 6)[]	JSON	Each item
value (anyOf 7)	null	Alternative

Referenced models: Update an agent — response body — workflow definition parameters item parameter type aws secret, Update an agent — response body — workflow definition parameters item parameter type azure secret, Update an agent — response body — workflow definition parameters item parameter type azure vault credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data, Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information, Update an agent — response body — workflow definition parameters item parameter type credential, Update an agent — response body — workflow definition parameters item parameter type onepassword, Update an agent — response body — workflow definition parameters item parameter type context, Update an agent — response body — workflow definition parameters item parameter type output, Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id

Update an agent — response body — workflow definition parameters item parameter type credential

Field	Type	Presence	Description and constraints
$	object	Root
created_at	string	Required within parent	Format: date-time
credential_id	string	Required within parent
credential_ids	JSON	Optional
credential_ids (anyOf 1)	array	Alternative
credential_ids (anyOf 1)[]	string	Each item
credential_ids (anyOf 2)	null	Alternative
credential_parameter_id	string	Required within parent
deleted_at	JSON	Optional
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
fallback_credential_ids	JSON	Optional
fallback_credential_ids (anyOf 1)	array	Alternative
fallback_credential_ids (anyOf 1)[]	string	Each item
fallback_credential_ids (anyOf 2)	null	Alternative
fallback_trigger	JSON	Optional
fallback_trigger (anyOf 1)	string	Alternative
fallback_trigger (anyOf 2)	null	Alternative
key	string	Required within parent
modified_at	string	Required within parent	Format: date-time
parameter_type	string	Required within parent	Must equal: credential Default: credential
selection_strategy	JSON	Optional
selection_strategy (anyOf 1)	string	Alternative
selection_strategy (anyOf 2)	null	Alternative
workflow_id	string	Required within parent

Update an agent — response body — workflow definition parameters item parameter type onepassword

Field	Type	Presence	Description and constraints
$	object	Root
created_at	string	Required within parent	Format: date-time
deleted_at	JSON	Optional
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
item_id	string	Required within parent
key	string	Required within parent
modified_at	string	Required within parent	Format: date-time
onepassword_credential_parameter_id	string	Required within parent
parameter_type	string	Required within parent	Must equal: onepassword Default: onepassword
totp_field_name	JSON	Optional
totp_field_name (anyOf 1)	string	Alternative
totp_field_name (anyOf 2)	null	Alternative
totp_identifier	JSON	Optional
totp_identifier (anyOf 1)	string	Alternative
totp_identifier (anyOf 2)	null	Alternative
vault_id	string	Required within parent
workflow_id	string	Required within parent

Update an agent — response body — workflow definition parameters item parameter type output

Field	Type	Presence	Description and constraints
$	object	Root
created_at	string	Required within parent	Format: date-time
deleted_at	JSON	Optional
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
key	string	Required within parent
modified_at	string	Required within parent	Format: date-time
output_parameter_id	string	Required within parent
parameter_type	string	Required within parent	Must equal: output Default: output
workflow_id	string	Required within parent

Update an agent — response body — workflow_definition / blocks / item / ai_fallback: fallback, proactive, block type action

Field	Type	Presence	Description and constraints
$	object	Root
ai_fallback	string	Optional	Controls how an action block uses a CSS/XPath selector relative to AI. - `fallback`: attempt the selector first; fall back to AI on failure. - `proactive`: always use AI; the selector (if any) is a hint only. When `selector` is None, both modes degrade to AI-only — the difference is purely semantic (whether the author expected to have a selector here). Known values: fallback, proactive Default: fallback
block_type	string	Required within parent	Must equal: action Default: action
complete_criterion	JSON	Optional
complete_criterion (anyOf 1)	string	Alternative
complete_criterion (anyOf 2)	null	Alternative
complete_criterion_is_untrusted	boolean	Optional	Default: false
complete_on_download	boolean	Optional	Default: false
complete_verification	boolean	Optional	Default: true
continue_on_failure	boolean	Optional	Default: false
data_extraction_goal	JSON	Optional
data_extraction_goal (anyOf 1)	string	Alternative
data_extraction_goal (anyOf 2)	null	Alternative
data_schema	JSON	Optional
data_schema (anyOf 1)	object	Alternative	Additional keys: allowed
data_schema (anyOf 2)	array	Alternative
data_schema (anyOf 2)[]	JSON	Each item
data_schema (anyOf 3)	string	Alternative
data_schema (anyOf 4)	null	Alternative
disable_cache	boolean	Optional	Default: false
download_suffix	JSON	Optional
download_suffix (anyOf 1)	string	Alternative
download_suffix (anyOf 2)	null	Alternative
download_timeout	JSON	Optional
download_timeout (anyOf 1)	JSON	Alternative
download_timeout (anyOf 1) (anyOf 1)	number	Alternative
download_timeout (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
download_timeout (anyOf 2)	null	Alternative
engine	JSON	Optional
engine (anyOf 1)	string	Alternative	Known values: skyvern-1.0, skyvern-2.0, skyvern-3.0, openai-cua, anthropic-cua, ui-tars, yutori-navigator
engine (anyOf 2)	null	Alternative
engine_pinned	boolean	Optional	Default: false
error_code_mapping	JSON	Optional
error_code_mapping (anyOf 1)	object	Alternative	Additional keys: see wildcard field
error_code_mapping (anyOf 1).*	string	Additional keys
error_code_mapping (anyOf 2)	null	Alternative
ignore_workflow_system_prompt	boolean	Optional	Default: false
include_action_history_in_verification	boolean	Optional	Default: false
include_extracted_text	boolean	Optional	Default: true
label	string	Required within parent	Author-facing identifier for a block; unique within a workflow.
max_retries	JSON	Optional
max_retries (anyOf 1)	integer	Alternative	Default: 0
max_retries (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_run	JSON	Optional
max_steps_per_run (anyOf 1)	JSON	Alternative
max_steps_per_run (anyOf 1) (anyOf 1)	integer	Alternative
max_steps_per_run (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_run (anyOf 2)	null	Alternative
model	JSON	Optional
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
navigation_goal	JSON	Optional
navigation_goal (anyOf 1)	string	Alternative
navigation_goal (anyOf 2)	null	Alternative
next_block_label	JSON	Optional	Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
output_parameter	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters	array	Optional	Default: []
parameters[]	JSON	Each item
parameters[] (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id
parameters[] (anyOf 2)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type credential
selector	JSON	Optional
selector (anyOf 1)	string	Alternative
selector (anyOf 2)	null	Alternative
task_type	string	Optional	Default: general
terminate_criterion	JSON	Optional
terminate_criterion (anyOf 1)	string	Alternative
terminate_criterion (anyOf 2)	null	Alternative
title	string	Optional	Default:
totp_identifier	JSON	Optional
totp_identifier (anyOf 1)	string	Alternative
totp_identifier (anyOf 2)	null	Alternative
totp_verification_url	JSON	Optional
totp_verification_url (anyOf 1)	string	Alternative
totp_verification_url (anyOf 2)	null	Alternative
url	JSON	Optional
url (anyOf 1)	string	Alternative
url (anyOf 2)	null	Alternative

Referenced models: Update an agent — response body — workflow definition parameters item parameter type aws secret, Update an agent — response body — workflow definition parameters item parameter type azure secret, Update an agent — response body — workflow definition parameters item parameter type azure vault credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data, Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information, Update an agent — response body — workflow definition parameters item parameter type credential, Update an agent — response body — workflow definition parameters item parameter type onepassword, Update an agent — response body — workflow definition parameters item parameter type context, Update an agent — response body — workflow definition parameters item parameter type output, Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id

Update an agent — response body — workflow_definition / blocks / item / block_type email_inbox, email_client: gmail, outlook

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: email_inbox Default: email_inbox
continue_on_failure	boolean	Optional	Default: false
credential_id	JSON	Optional
credential_id (anyOf 1)	string	Alternative
credential_id (anyOf 2)	null	Alternative
disable_cache	boolean	Optional	Default: false
download_attachments	boolean	Optional	Default: false
email_client	string	Required within parent	Known values: gmail, outlook
folder	JSON	Optional
folder (anyOf 1)	string	Alternative
folder (anyOf 2)	null	Alternative
ignore_workflow_system_prompt	boolean	Optional	Default: false
include_body	boolean	Optional	Default: true
label	string	Required within parent	Author-facing identifier for a block; unique within a workflow.
max_results	JSON	Optional
max_results (anyOf 1)	integer	Alternative	Default: 25
max_results (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
model	JSON	Optional
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
newer_than_days	JSON	Optional
newer_than_days (anyOf 1)	JSON	Alternative
newer_than_days (anyOf 1) (anyOf 1)	integer	Alternative
newer_than_days (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
newer_than_days (anyOf 2)	null	Alternative
next_block_label	JSON	Optional	Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
output_parameter	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters	array	Optional	Default: []
parameters[]	JSON	Each item
parameters[] (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id
parameters[] (anyOf 2)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type credential
prompt	JSON	Optional
prompt (anyOf 1)	string	Alternative
prompt (anyOf 2)	null	Alternative
sender	JSON	Optional
sender (anyOf 1)	string	Alternative
sender (anyOf 2)	null	Alternative
subject	JSON	Optional
subject (anyOf 1)	string	Alternative
subject (anyOf 2)	null	Alternative

Referenced models: Update an agent — response body — workflow definition parameters item parameter type aws secret, Update an agent — response body — workflow definition parameters item parameter type azure secret, Update an agent — response body — workflow definition parameters item parameter type azure vault credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data, Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information, Update an agent — response body — workflow definition parameters item parameter type credential, Update an agent — response body — workflow definition parameters item parameter type onepassword, Update an agent — response body — workflow definition parameters item parameter type context, Update an agent — response body — workflow definition parameters item parameter type output, Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id

Update an agent — response body — workflow_definition / blocks / item / block_type file_download, download_target: website, s3, azure, google drive, sftp

Field	Type	Presence	Description and constraints
$	object	Root
aws_access_key_id	JSON	Optional
aws_access_key_id (anyOf 1)	string	Alternative
aws_access_key_id (anyOf 2)	null	Alternative
aws_secret_access_key	JSON	Optional
aws_secret_access_key (anyOf 1)	string	Alternative
aws_secret_access_key (anyOf 2)	null	Alternative
azure_blob_container_name	JSON	Optional
azure_blob_container_name (anyOf 1)	string	Alternative
azure_blob_container_name (anyOf 2)	null	Alternative
azure_storage_account_key	JSON	Optional
azure_storage_account_key (anyOf 1)	string	Alternative
azure_storage_account_key (anyOf 2)	null	Alternative
azure_storage_account_name	JSON	Optional
azure_storage_account_name (anyOf 1)	string	Alternative
azure_storage_account_name (anyOf 2)	null	Alternative
block_type	string	Required within parent	Must equal: file_download Default: file_download
complete_criterion	JSON	Optional
complete_criterion (anyOf 1)	string	Alternative
complete_criterion (anyOf 2)	null	Alternative
complete_criterion_is_untrusted	boolean	Optional	Default: false
complete_on_download	boolean	Optional	Default: false
complete_verification	boolean	Optional	Default: true
continue_on_empty	boolean	Optional	When the run download directory has no files, allow the empty upload only after confirming no registered, browser-session, or alternate candidate downloads exist (False, default). Set True to always allow an empty upload. Default: false
continue_on_failure	boolean	Optional	Default: false
data_extraction_goal	JSON	Optional
data_extraction_goal (anyOf 1)	string	Alternative
data_extraction_goal (anyOf 2)	null	Alternative
data_schema	JSON	Optional
data_schema (anyOf 1)	object	Alternative	Additional keys: allowed
data_schema (anyOf 2)	array	Alternative
data_schema (anyOf 2)[]	JSON	Each item
data_schema (anyOf 3)	string	Alternative
data_schema (anyOf 4)	null	Alternative
disable_cache	boolean	Optional	Default: false
download_suffix	JSON	Optional
download_suffix (anyOf 1)	string	Alternative
download_suffix (anyOf 2)	null	Alternative
download_target	string	Optional	Known values: website, s3, azure, google_drive, sftp Default: website
download_timeout	JSON	Optional
download_timeout (anyOf 1)	JSON	Alternative
download_timeout (anyOf 1) (anyOf 1)	number	Alternative
download_timeout (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
download_timeout (anyOf 2)	null	Alternative
endpoint_url	JSON	Optional
endpoint_url (anyOf 1)	string	Alternative
endpoint_url (anyOf 2)	null	Alternative
engine	JSON	Optional
engine (anyOf 1)	string	Alternative	Known values: skyvern-1.0, skyvern-2.0, skyvern-3.0, openai-cua, anthropic-cua, ui-tars, yutori-navigator
engine (anyOf 2)	null	Alternative
engine_pinned	boolean	Optional	Default: false
error_code_mapping	JSON	Optional
error_code_mapping (anyOf 1)	object	Alternative	Additional keys: see wildcard field
error_code_mapping (anyOf 1).*	string	Additional keys
error_code_mapping (anyOf 2)	null	Alternative
google_credential_id	JSON	Optional
google_credential_id (anyOf 1)	string	Alternative
google_credential_id (anyOf 2)	null	Alternative
google_drive_folder_id	JSON	Optional
google_drive_folder_id (anyOf 1)	string	Alternative
google_drive_folder_id (anyOf 2)	null	Alternative
ignore_workflow_system_prompt	boolean	Optional	Default: false
include_action_history_in_verification	boolean	Optional	Default: false
include_extracted_text	boolean	Optional	Default: true
label	string	Required within parent	Author-facing identifier for a block; unique within a workflow.
max_retries	JSON	Optional
max_retries (anyOf 1)	integer	Alternative	Default: 0
max_retries (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_run	JSON	Optional
max_steps_per_run (anyOf 1)	JSON	Alternative
max_steps_per_run (anyOf 1) (anyOf 1)	integer	Alternative
max_steps_per_run (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_run (anyOf 2)	null	Alternative
model	JSON	Optional
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
navigation_goal	JSON	Optional
navigation_goal (anyOf 1)	string	Alternative
navigation_goal (anyOf 2)	null	Alternative
next_block_label	JSON	Optional	Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
output_parameter	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters	array	Optional	Default: []
parameters[]	JSON	Each item
parameters[] (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id
parameters[] (anyOf 2)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type credential
path	JSON	Optional
path (anyOf 1)	string	Alternative
path (anyOf 2)	null	Alternative
prompt	JSON	Optional	Optional natural-language control over which downloaded files are uploaded; empty means upload all.
prompt (anyOf 1)	string	Alternative
prompt (anyOf 2)	null	Alternative
region_name	JSON	Optional
region_name (anyOf 1)	string	Alternative
region_name (anyOf 2)	null	Alternative
s3_bucket	JSON	Optional
s3_bucket (anyOf 1)	string	Alternative
s3_bucket (anyOf 2)	null	Alternative
sftp_host	JSON	Optional
sftp_host (anyOf 1)	string	Alternative
sftp_host (anyOf 2)	null	Alternative
sftp_host_key	JSON	Optional
sftp_host_key (anyOf 1)	string	Alternative
sftp_host_key (anyOf 2)	null	Alternative
sftp_password	JSON	Optional
sftp_password (anyOf 1)	string	Alternative
sftp_password (anyOf 2)	null	Alternative
sftp_port	JSON	Optional
sftp_port (anyOf 1)	JSON	Alternative
sftp_port (anyOf 1) (anyOf 1)	integer	Alternative
sftp_port (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sftp_port (anyOf 2)	null	Alternative
sftp_private_key	JSON	Optional
sftp_private_key (anyOf 1)	string	Alternative
sftp_private_key (anyOf 2)	null	Alternative
sftp_private_key_passphrase	JSON	Optional
sftp_private_key_passphrase (anyOf 1)	string	Alternative
sftp_private_key_passphrase (anyOf 2)	null	Alternative
sftp_remote_path	JSON	Optional
sftp_remote_path (anyOf 1)	string	Alternative
sftp_remote_path (anyOf 2)	null	Alternative
sftp_source_path	JSON	Optional
sftp_source_path (anyOf 1)	string	Alternative
sftp_source_path (anyOf 2)	null	Alternative
sftp_username	JSON	Optional
sftp_username (anyOf 1)	string	Alternative
sftp_username (anyOf 2)	null	Alternative
task_type	string	Optional	Default: general
terminate_criterion	JSON	Optional
terminate_criterion (anyOf 1)	string	Alternative
terminate_criterion (anyOf 2)	null	Alternative
title	string	Optional	Default:
totp_identifier	JSON	Optional
totp_identifier (anyOf 1)	string	Alternative
totp_identifier (anyOf 2)	null	Alternative
totp_verification_url	JSON	Optional
totp_verification_url (anyOf 1)	string	Alternative
totp_verification_url (anyOf 2)	null	Alternative
url	JSON	Optional
url (anyOf 1)	string	Alternative
url (anyOf 2)	null	Alternative

Referenced models: Update an agent — response body — workflow definition parameters item parameter type aws secret, Update an agent — response body — workflow definition parameters item parameter type azure secret, Update an agent — response body — workflow definition parameters item parameter type azure vault credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data, Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information, Update an agent — response body — workflow definition parameters item parameter type credential, Update an agent — response body — workflow definition parameters item parameter type onepassword, Update an agent — response body — workflow definition parameters item parameter type context, Update an agent — response body — workflow definition parameters item parameter type output, Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id

Update an agent — response body — workflow_definition / blocks / item / block_type file_upload, storage_type: s3, azure, google drive, sftp

Field	Type	Presence	Description and constraints
$	object	Root
aws_access_key_id	JSON	Optional
aws_access_key_id (anyOf 1)	string	Alternative
aws_access_key_id (anyOf 2)	null	Alternative
aws_secret_access_key	JSON	Optional
aws_secret_access_key (anyOf 1)	string	Alternative
aws_secret_access_key (anyOf 2)	null	Alternative
azure_blob_container_name	JSON	Optional
azure_blob_container_name (anyOf 1)	string	Alternative
azure_blob_container_name (anyOf 2)	null	Alternative
azure_storage_account_key	JSON	Optional
azure_storage_account_key (anyOf 1)	string	Alternative
azure_storage_account_key (anyOf 2)	null	Alternative
azure_storage_account_name	JSON	Optional
azure_storage_account_name (anyOf 1)	string	Alternative
azure_storage_account_name (anyOf 2)	null	Alternative
block_type	string	Required within parent	Must equal: file_upload Default: file_upload
continue_on_empty	boolean	Optional	When the run download directory has no files, allow the empty upload only after confirming no registered, browser-session, or alternate candidate downloads exist (False, default). Set True to always allow an empty upload. Default: false
continue_on_failure	boolean	Optional	Default: false
disable_cache	boolean	Optional	Default: false
endpoint_url	JSON	Optional
endpoint_url (anyOf 1)	string	Alternative
endpoint_url (anyOf 2)	null	Alternative
google_credential_id	JSON	Optional
google_credential_id (anyOf 1)	string	Alternative
google_credential_id (anyOf 2)	null	Alternative
google_drive_folder_id	JSON	Optional
google_drive_folder_id (anyOf 1)	string	Alternative
google_drive_folder_id (anyOf 2)	null	Alternative
ignore_workflow_system_prompt	boolean	Optional	Default: false
label	string	Required within parent	Author-facing identifier for a block; unique within a workflow.
model	JSON	Optional
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
next_block_label	JSON	Optional	Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
output_parameter	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type output
path	JSON	Optional
path (anyOf 1)	string	Alternative
path (anyOf 2)	null	Alternative
prompt	JSON	Optional	Optional natural-language control over which downloaded files are uploaded; empty means upload all.
prompt (anyOf 1)	string	Alternative
prompt (anyOf 2)	null	Alternative
region_name	JSON	Optional
region_name (anyOf 1)	string	Alternative
region_name (anyOf 2)	null	Alternative
s3_bucket	JSON	Optional
s3_bucket (anyOf 1)	string	Alternative
s3_bucket (anyOf 2)	null	Alternative
sftp_host	JSON	Optional
sftp_host (anyOf 1)	string	Alternative
sftp_host (anyOf 2)	null	Alternative
sftp_host_key	JSON	Optional
sftp_host_key (anyOf 1)	string	Alternative
sftp_host_key (anyOf 2)	null	Alternative
sftp_password	JSON	Optional
sftp_password (anyOf 1)	string	Alternative
sftp_password (anyOf 2)	null	Alternative
sftp_port	JSON	Optional
sftp_port (anyOf 1)	JSON	Alternative
sftp_port (anyOf 1) (anyOf 1)	integer	Alternative
sftp_port (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sftp_port (anyOf 2)	null	Alternative
sftp_private_key	JSON	Optional
sftp_private_key (anyOf 1)	string	Alternative
sftp_private_key (anyOf 2)	null	Alternative
sftp_private_key_passphrase	JSON	Optional
sftp_private_key_passphrase (anyOf 1)	string	Alternative
sftp_private_key_passphrase (anyOf 2)	null	Alternative
sftp_remote_path	JSON	Optional
sftp_remote_path (anyOf 1)	string	Alternative
sftp_remote_path (anyOf 2)	null	Alternative
sftp_username	JSON	Optional
sftp_username (anyOf 1)	string	Alternative
sftp_username (anyOf 2)	null	Alternative
storage_type	string	Optional	Known values: s3, azure, google_drive, sftp Default: s3

Referenced models: Update an agent — response body — workflow definition parameters item parameter type output

Update an agent — response body — workflow_definition / blocks / item / block_type file_url_parser, file_type: auto detect, csv, excel, pdf, image, docx, zip

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: file_url_parser Default: file_url_parser
continue_on_failure	boolean	Optional	Default: false
disable_cache	boolean	Optional	Default: false
file_type	string	Optional	Known values: auto_detect, csv, excel, pdf, image, docx, zip Default: auto_detect
file_url	string	Required within parent
force_ocr	boolean	Optional	PDF only: ignore the PDF's embedded text layer and read the pages with vision OCR instead. Use it when a PDF's text layer is unreadable in a way Skyvern does not detect on its own. OCR reads at most the first 50 pages, so a longer PDF loses the rest; leave this off unless the text layer is unusable. Default: false
ignore_workflow_system_prompt	boolean	Optional	Default: false
json_schema	JSON	Optional
json_schema (anyOf 1)	object	Alternative	Additional keys: allowed
json_schema (anyOf 2)	null	Alternative
label	string	Required within parent	Author-facing identifier for a block; unique within a workflow.
model	JSON	Optional
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
next_block_label	JSON	Optional	Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
output_parameter	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type output
worksheet	JSON	Optional
worksheet (anyOf 1)	string	Alternative
worksheet (anyOf 2)	null	Alternative

Referenced models: Update an agent — response body — workflow definition parameters item parameter type output

Update an agent — response body — workflow_definition / blocks / item / block_type google_sheets_write, write_mode: append, update

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: google_sheets_write Default: google_sheets_write
column_mapping	JSON	Optional
column_mapping (anyOf 1)	object	Alternative	Additional keys: see wildcard field
column_mapping (anyOf 1).*	string	Additional keys
column_mapping (anyOf 2)	null	Alternative
continue_on_failure	boolean	Optional	Default: false
create_sheet_if_missing	boolean	Optional	Default: false
credential_id	JSON	Optional
credential_id (anyOf 1)	string	Alternative
credential_id (anyOf 2)	null	Alternative
disable_cache	boolean	Optional	Default: false
ignore_workflow_system_prompt	boolean	Optional	Default: false
label	string	Required within parent	Author-facing identifier for a block; unique within a workflow.
model	JSON	Optional
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
next_block_label	JSON	Optional	Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
output_parameter	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters	array	Optional	Default: []
parameters[]	JSON	Each item
parameters[] (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id
parameters[] (anyOf 2)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type credential
range	JSON	Optional
range (anyOf 1)	string	Alternative
range (anyOf 2)	null	Alternative
sheet_name	JSON	Optional
sheet_name (anyOf 1)	string	Alternative
sheet_name (anyOf 2)	null	Alternative
spreadsheet_url	string	Required within parent
values	string	Optional	Default:
write_mode	string	Optional	Known values: append, update Default: append

Referenced models: Update an agent — response body — workflow definition parameters item parameter type aws secret, Update an agent — response body — workflow definition parameters item parameter type azure secret, Update an agent — response body — workflow definition parameters item parameter type azure vault credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data, Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information, Update an agent — response body — workflow definition parameters item parameter type credential, Update an agent — response body — workflow definition parameters item parameter type onepassword, Update an agent — response body — workflow definition parameters item parameter type context, Update an agent — response body — workflow definition parameters item parameter type output, Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id

Update an agent — response body — workflow_definition / blocks / item / block_type human_interaction, body_format: text, html

Field	Type	Presence	Description and constraints
$	object	Root	A block for human/agent interaction. For the first pass at this, the implicit behaviour is that the user is given a single binary choice (a go//no-go). If the human: - chooses positively, the workflow continues - chooses negatively, the workflow is terminated - does not respond within the timeout period, the workflow terminates
block_type	string	Required within parent	Must equal: human_interaction Default: human_interaction
body	string	Optional	Default: Your interaction is required for a workflow run!
body_format	string	Optional	Known values: text, html Default: text
complete_criterion	JSON	Optional
complete_criterion (anyOf 1)	string	Alternative
complete_criterion (anyOf 2)	null	Alternative
complete_criterion_is_untrusted	boolean	Optional	Default: false
complete_on_download	boolean	Optional	Default: false
complete_verification	boolean	Optional	Default: true
continue_on_failure	boolean	Optional	Default: false
data_extraction_goal	JSON	Optional
data_extraction_goal (anyOf 1)	string	Alternative
data_extraction_goal (anyOf 2)	null	Alternative
data_schema	JSON	Optional
data_schema (anyOf 1)	object	Alternative	Additional keys: allowed
data_schema (anyOf 2)	array	Alternative
data_schema (anyOf 2)[]	JSON	Each item
data_schema (anyOf 3)	string	Alternative
data_schema (anyOf 4)	null	Alternative
disable_cache	boolean	Optional	Default: false
download_suffix	JSON	Optional
download_suffix (anyOf 1)	string	Alternative
download_suffix (anyOf 2)	null	Alternative
download_timeout	JSON	Optional
download_timeout (anyOf 1)	JSON	Alternative
download_timeout (anyOf 1) (anyOf 1)	number	Alternative
download_timeout (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
download_timeout (anyOf 2)	null	Alternative
engine	JSON	Optional	Default: skyvern-1.0
engine (anyOf 1)	string	Alternative	Known values: skyvern-1.0, skyvern-2.0, skyvern-3.0, openai-cua, anthropic-cua, ui-tars, yutori-navigator
engine (anyOf 2)	null	Alternative
engine_pinned	boolean	Optional	Default: false
error_code_mapping	JSON	Optional
error_code_mapping (anyOf 1)	object	Alternative	Additional keys: see wildcard field
error_code_mapping (anyOf 1).*	string	Additional keys
error_code_mapping (anyOf 2)	null	Alternative
ignore_workflow_system_prompt	boolean	Optional	Default: false
include_action_history_in_verification	boolean	Optional	Default: false
include_extracted_text	boolean	Optional	Default: true
instructions	string	Optional	Default: Please review and approve or reject to continue the workflow.
label	string	Required within parent	Author-facing identifier for a block; unique within a workflow.
max_retries	JSON	Optional
max_retries (anyOf 1)	integer	Alternative	Default: 0
max_retries (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_run	JSON	Optional
max_steps_per_run (anyOf 1)	JSON	Alternative
max_steps_per_run (anyOf 1) (anyOf 1)	integer	Alternative
max_steps_per_run (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_run (anyOf 2)	null	Alternative
model	JSON	Optional
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
navigation_goal	JSON	Optional
navigation_goal (anyOf 1)	string	Alternative
navigation_goal (anyOf 2)	null	Alternative
negative_descriptor	string	Optional	Default: Reject
next_block_label	JSON	Optional	Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
output_parameter	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters	array	Optional	Default: []
parameters[]	JSON	Each item
parameters[] (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id
parameters[] (anyOf 2)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type credential
positive_descriptor	string	Optional	Default: Approve
recipients	array	Optional	Default: []
recipients[]	string	Each item
sender	string	Optional	Default: hello at skyvern.com
subject	string	Optional	Default: Human interaction required for workflow run
task_type	string	Optional	Default: general
terminate_criterion	JSON	Optional
terminate_criterion (anyOf 1)	string	Alternative
terminate_criterion (anyOf 2)	null	Alternative
timeout_seconds	JSON	Optional
timeout_seconds (anyOf 1)	integer	Alternative	Default: 7200
timeout_seconds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
title	string	Optional	Default:
totp_identifier	JSON	Optional
totp_identifier (anyOf 1)	string	Alternative
totp_identifier (anyOf 2)	null	Alternative
totp_verification_url	JSON	Optional
totp_verification_url (anyOf 1)	string	Alternative
totp_verification_url (anyOf 2)	null	Alternative
url	JSON	Optional
url (anyOf 1)	string	Alternative
url (anyOf 2)	null	Alternative

Referenced models: Update an agent — response body — workflow definition parameters item parameter type aws secret, Update an agent — response body — workflow definition parameters item parameter type azure secret, Update an agent — response body — workflow definition parameters item parameter type azure vault credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data, Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information, Update an agent — response body — workflow definition parameters item parameter type credential, Update an agent — response body — workflow definition parameters item parameter type onepassword, Update an agent — response body — workflow definition parameters item parameter type context, Update an agent — response body — workflow definition parameters item parameter type output, Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id

Update an agent — response body — workflow_definition / blocks / item / block_type send_email, body_format: text, html

Field	Type	Presence	Description and constraints
$	object	Root
bcc	array	Optional	Default: []
bcc[]	string	Each item
block_type	string	Required within parent	Must equal: send_email Default: send_email
body	string	Required within parent
body_format	string	Optional	Known values: text, html Default: text
cc	array	Optional	Default: []
cc[]	string	Each item
continue_on_failure	boolean	Optional	Default: false
credential_id	JSON	Optional
credential_id (anyOf 1)	string	Alternative
credential_id (anyOf 2)	null	Alternative
custom_smtp_host	JSON	Optional
custom_smtp_host (anyOf 1)	string	Alternative
custom_smtp_host (anyOf 2)	null	Alternative
custom_smtp_password	JSON	Optional
custom_smtp_password (anyOf 1)	string	Alternative
custom_smtp_password (anyOf 2)	null	Alternative
custom_smtp_port	JSON	Optional
custom_smtp_port (anyOf 1)	JSON	Alternative
custom_smtp_port (anyOf 1) (anyOf 1)	integer	Alternative	Maximum: 65535.0 Minimum: 1.0
custom_smtp_port (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
custom_smtp_port (anyOf 2)	null	Alternative
custom_smtp_username	JSON	Optional
custom_smtp_username (anyOf 1)	string	Alternative
custom_smtp_username (anyOf 2)	null	Alternative
disable_cache	boolean	Optional	Default: false
file_attachments	array	Optional	Default: []
file_attachments[]	string	Each item
ignore_workflow_system_prompt	boolean	Optional	Default: false
label	string	Required within parent	Author-facing identifier for a block; unique within a workflow.
model	JSON	Optional
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
next_block_label	JSON	Optional	Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
output_parameter	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type output
recipients	array	Required within parent
recipients[]	string	Each item
sender	string	Required within parent
smtp_host	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type aws secret
smtp_password	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type aws secret
smtp_port	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type aws secret
smtp_username	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type aws secret
subject	string	Required within parent
transport	JSON	Optional
transport (anyOf 1)	string	Alternative	Known values: smtp, gmail
transport (anyOf 2)	null	Alternative

Referenced models: Update an agent — response body — workflow definition parameters item parameter type aws secret, Update an agent — response body — workflow definition parameters item parameter type output

Update an agent — response body — workflow_definition / blocks / item / block_type web_search, provider: auto, google, exa

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: web_search Default: web_search
continue_on_failure	boolean	Optional	Default: false
disable_cache	boolean	Optional	Default: false
error_code_mapping	JSON	Optional
error_code_mapping (anyOf 1)	object	Alternative	Additional keys: see wildcard field
error_code_mapping (anyOf 1).*	string	Additional keys
error_code_mapping (anyOf 2)	null	Alternative
ignore_workflow_system_prompt	boolean	Optional	Default: false
json_schema	JSON	Optional
json_schema (anyOf 1)	object	Alternative	Additional keys: allowed
json_schema (anyOf 2)	null	Alternative
label	string	Required within parent	Author-facing identifier for a block; unique within a workflow.
model	JSON	Optional
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
next_block_label	JSON	Optional	Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
no_match_error_code	JSON	Optional	Deprecated. Use error_code_mapping.
no_match_error_code (anyOf 1)	string	Alternative	Maximum length: 100 Minimum length: 1
no_match_error_code (anyOf 2)	null	Alternative
no_results_error_code	JSON	Optional	Deprecated. Use error_code_mapping.
no_results_error_code (anyOf 1)	string	Alternative	Maximum length: 100 Minimum length: 1
no_results_error_code (anyOf 2)	null	Alternative
num_results	JSON	Optional
num_results (anyOf 1)	integer	Alternative	Default: 10 Maximum: 100.0 Minimum: 1.0
num_results (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
output_parameter	Model	Required within parent	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters	array	Optional	Default: []
parameters[]	JSON	Each item
parameters[] (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id
parameters[] (anyOf 2)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)	Model	Alternative	Expand Update an agent — response body — workflow definition parameters item parameter type credential
prompt	JSON	Optional
prompt (anyOf 1)	string	Alternative
prompt (anyOf 2)	null	Alternative
provider	string	Optional	Known values: auto, google, exa Default: auto
query	string	Required within parent	Minimum length: 1

Referenced models: Update an agent — response body — workflow definition parameters item parameter type aws secret, Update an agent — response body — workflow definition parameters item parameter type azure secret, Update an agent — response body — workflow definition parameters item parameter type azure vault credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data, Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential, Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information, Update an agent — response body — workflow definition parameters item parameter type credential, Update an agent — response body — workflow definition parameters item parameter type onepassword, Update an agent — response body — workflow definition parameters item parameter type context, Update an agent — response body — workflow definition parameters item parameter type output, Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id

Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id

Field	Type	Presence	Description and constraints
$	object	Root
created_at	string	Required within parent	Format: date-time
default_value	JSON	Optional
default_value (anyOf 1)	string	Alternative
default_value (anyOf 2)	JSON	Alternative
default_value (anyOf 2) (anyOf 1)	integer	Alternative
default_value (anyOf 2) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
default_value (anyOf 3)	JSON	Alternative
default_value (anyOf 3) (anyOf 1)	number	Alternative
default_value (anyOf 3) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
default_value (anyOf 4)	boolean	Alternative
default_value (anyOf 5)	object	Alternative	Additional keys: allowed
default_value (anyOf 6)	array	Alternative
default_value (anyOf 6)[]	JSON	Each item
default_value (anyOf 7)	null	Alternative
deleted_at	JSON	Optional
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
key	string	Required within parent
modified_at	string	Required within parent	Format: date-time
parameter_type	string	Required within parent	Must equal: workflow Default: workflow
workflow_id	string	Required within parent
workflow_parameter_id	string	Required within parent
workflow_parameter_type	string	Required within parent	Known values: string, integer, float, boolean, json, file_url, credential_id

Update an agent — response body — workflow_definition / retry_policy / webhook_on_retry: final only, every attempt

Field	Type	Presence	Description and constraints
$	object	Root
delay_seconds	JSON	Optional
delay_seconds (anyOf 1)	integer	Alternative	Fixed delay before the next attempt, in seconds Default: 0 Maximum: 3600.0 Minimum: 0.0
delay_seconds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_retries	JSON	Optional
max_retries (anyOf 1)	integer	Alternative	Maximum number of retries after the initial attempt Default: 1 Maximum: 5.0 Minimum: 1.0
max_retries (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
retry_on	array	Required within parent	Terminal status rules that enable retries Minimum items: 1
retry_on[]	Model	Each item	Expand Update an agent — response body — workflow_definition / retry_policy / webhook_on_retry: final only, every attempt retry on item
webhook_on_retry	string	Optional	Whether to send a webhook for every attempt or only the final attempt Known values: final_only, every_attempt Default: final_only

Referenced models: Update an agent — response body — workflow_definition / retry_policy / webhook_on_retry: final only, every attempt retry on item

Update an agent — response body — workflow_definition / retry_policy / webhook_on_retry: final only, every attempt retry on item

Field	Type	Presence	Description and constraints
$	object	Root
error_codes	JSON	Optional	Optional error codes. The rule matches when any listed code is present.
error_codes (anyOf 1)	array	Alternative
error_codes (anyOf 1)[]	string	Each item	Minimum length: 1
error_codes (anyOf 2)	null	Alternative
status	string	Required within parent	Terminal status that triggers a retry rule; canceled is accepted for forward compatibility, but a canceled run never retries in the current runtime, including explicit API/UI cancels. Known values: completed, failed, terminated, canceled, timed_out