Skyvern: Agents schemas (part 2)

← Agents operations · All schemas

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type terminate

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: terminate Default: terminate
continue_on_failure	boolean	Optional	Default: false
error_code	JSON	Optional	Optional error code added to the run's error codes; supports Jinja templating. A literal code must be at most 128 characters. The rendered code must be at most 128 characters and may contain only ASCII letters, digits, underscores, periods, colons, and hyphens.
error_code (anyOf 1)	string	Alternative
error_code (anyOf 2)	null	Alternative
ignore_workflow_system_prompt	boolean	Optional	Default: false
label	string	Required within parent	Author-facing identifier; must be unique per 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 label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]].
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
reason	string	Required within parent	Why the run ends here; supports Jinja templating. Minimum length: 1

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type text prompt

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: text_prompt Default: text_prompt
continue_on_failure	boolean	Optional	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; must be unique per workflow.
llm_key	JSON	Optional
llm_key (anyOf 1)	string	Alternative
llm_key (anyOf 2)	null	Alternative
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 label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]].
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
parameter_keys	JSON	Optional
parameter_keys (anyOf 1)	array	Alternative
parameter_keys (anyOf 1)[]	string	Each item
parameter_keys (anyOf 2)	null	Alternative
prompt	string	Required within parent

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type upload to s3

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: upload_to_s3 Default: upload_to_s3
continue_on_failure	boolean	Optional	Default: false
ignore_workflow_system_prompt	boolean	Optional	Default: false
label	string	Required within parent	Author-facing identifier; must be unique per 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 label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]].
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
path	JSON	Optional
path (anyOf 1)	string	Alternative
path (anyOf 2)	null	Alternative

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type validation

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: validation Default: validation
complete_criterion	JSON	Optional
complete_criterion (anyOf 1)	string	Alternative
complete_criterion (anyOf 2)	null	Alternative
continue_on_failure	boolean	Optional	Default: false
disable_cache	boolean	Optional	Default: false
engine	JSON	Optional
engine (anyOf 1)	string	Alternative	One of: 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	Set to true only when skyvern-1.0 was explicitly chosen for this block; leave it unset otherwise. 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
label	string	Required within parent	Author-facing identifier; must be unique per workflow.
max_steps_per_run	JSON	Optional
max_steps_per_run (anyOf 1)	integer	Alternative
max_steps_per_run (anyOf 2)	null	Alternative
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 label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]].
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
parameter_keys	JSON	Optional
parameter_keys (anyOf 1)	array	Alternative
parameter_keys (anyOf 1)[]	string	Each item
parameter_keys (anyOf 2)	null	Alternative
terminate_criterion	JSON	Optional
terminate_criterion (anyOf 1)	string	Alternative
terminate_criterion (anyOf 2)	null	Alternative
without_page_information	boolean	Optional	Default: false

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type wait

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: wait Default: wait
continue_on_failure	boolean	Optional	Default: false
ignore_workflow_system_prompt	boolean	Optional	Default: false
label	string	Required within parent	Author-facing identifier; must be unique per 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 label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]].
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
wait_sec	integer	Optional	Default: 0

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed 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
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; must be unique per 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 label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]].
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	integer	Optional	Default: 10 Maximum: 100.0 Minimum: 1.0
parameter_keys	JSON	Optional
parameter_keys (anyOf 1)	array	Alternative
parameter_keys (anyOf 1)[]	string	Each item
parameter_keys (anyOf 2)	null	Alternative
prompt	JSON	Optional
prompt (anyOf 1)	string	Alternative
prompt (anyOf 2)	null	Alternative
provider	string	Optional	Default: auto One of: auto, google, exa
query	string	Required within parent	Minimum length: 1

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type while loop

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: while_loop Default: while_loop
condition	Model	Required within parent	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type while loop condition
continue_on_failure	boolean	Optional	Default: false
ignore_workflow_system_prompt	boolean	Optional	Default: false
label	string	Required within parent	Author-facing identifier; must be unique per workflow.
loop_blocks	array	Required within parent
loop_blocks[]	JSON	Each item
loop_blocks[] (oneOf 1)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type task
loop_blocks[] (oneOf 2)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type for loop
loop_blocks[] (oneOf 3)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type while loop
loop_blocks[] (oneOf 4)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type code
loop_blocks[] (oneOf 5)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type text prompt
loop_blocks[] (oneOf 6)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type download to s3
loop_blocks[] (oneOf 7)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type upload to s3
loop_blocks[] (oneOf 8)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type file upload, storage type: s3, azure, google drive, sftp
loop_blocks[] (oneOf 9)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type send email, body format: text, html
loop_blocks[] (oneOf 10)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type file url parser, file type: auto detect, csv, excel, pdf, image, docx, zip
loop_blocks[] (oneOf 11)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type validation
loop_blocks[] (oneOf 12)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item ai fallback: fallback, proactive, block type action
loop_blocks[] (oneOf 13)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type navigation
loop_blocks[] (oneOf 14)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type extraction
loop_blocks[] (oneOf 15)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type login
loop_blocks[] (oneOf 16)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type wait
loop_blocks[] (oneOf 17)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type human interaction, body format: text, html
loop_blocks[] (oneOf 18)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type file download, download target: website, s3, azure, google drive, sftp
loop_blocks[] (oneOf 19)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type data export
loop_blocks[] (oneOf 20)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type terminate
loop_blocks[] (oneOf 21)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type agent step
loop_blocks[] (oneOf 22)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type goto url
loop_blocks[] (oneOf 23)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type pdf parser
loop_blocks[] (oneOf 24)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type task v2
loop_blocks[] (oneOf 25)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type http request
loop_blocks[] (oneOf 26)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type web search, provider: auto, google, exa
loop_blocks[] (oneOf 27)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type conditional
loop_blocks[] (oneOf 28)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type print page, format: A4, Letter, Legal, Tabloid
loop_blocks[] (oneOf 29)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type pdf fill
loop_blocks[] (oneOf 30)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type split pdf
loop_blocks[] (oneOf 31)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type workflow trigger
loop_blocks[] (oneOf 32)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type google sheets read
loop_blocks[] (oneOf 33)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type email inbox, email client: gmail, outlook
loop_blocks[] (oneOf 34)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type google sheets write, write mode: append, update
loop_blocks[] (oneOf 35)	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type powerbi query
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 label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]].
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false

Referenced models: Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item ai fallback: fallback, proactive, block type action, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type agent step, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type while loop condition, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type code, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type conditional, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type data export, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type download to s3, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type email inbox, email client: gmail, outlook, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type extraction, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type file download, download target: website, s3, azure, google drive, sftp, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type file url parser, file type: auto detect, csv, excel, pdf, image, docx, zip, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type file upload, storage type: s3, azure, google drive, sftp, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type for loop, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type google sheets read, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type google sheets write, write mode: append, update, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type http request, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type human interaction, body format: text, html, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type login, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type navigation, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type pdf parser, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type pdf fill, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type powerbi query, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type print page, format: A4, Letter, Legal, Tabloid, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type send email, body format: text, html, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type split pdf, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type task, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type task v2, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type terminate, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type text prompt, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type upload to s3, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type goto url, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type validation, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type wait, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type web search, provider: auto, google, exa, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type while loop, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type workflow trigger

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type while loop condition

Field	Type	Presence	Description and constraints
$	object	Root
criteria_type	string	Optional	Default: jinja2_template One of: jinja2_template, prompt
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
expression	string	Required within parent

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed 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
ignore_workflow_system_prompt	boolean	Optional	Default: false
label	string	Required within parent	Author-facing identifier; must be unique per 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 label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]].
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative
next_loop_on_failure	boolean	Optional	Default: false
parameter_keys	JSON	Optional
parameter_keys (anyOf 1)	array	Alternative
parameter_keys (anyOf 1)[]	string	Each item
parameter_keys (anyOf 2)	null	Alternative
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

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition parameters item parameter type aws secret

Field	Type	Presence	Description and constraints
$	object	Root
aws_key	string	Required within parent
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: aws_secret Default: aws_secret

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition parameters item parameter type azure vault credential

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: 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

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed 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_item_id	string	Required within parent
bitwarden_master_password_aws_secret_key	string	Required within parent
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: bitwarden_credit_card_data Default: bitwarden_credit_card_data

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed 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_master_password_aws_secret_key	string	Required within parent
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: 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

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed 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
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: bitwarden_sensitive_information Default: bitwarden_sensitive_information

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed 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_parameter_key	string	Required within parent

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition parameters item parameter type credential

Field	Type	Presence	Description and constraints
$	object	Root
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
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
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

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition parameters item parameter type onepassword

Field	Type	Presence	Description and constraints
$	object	Root
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
item_id	string	Required within parent
key	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

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition parameters item parameter type output

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: output Default: output

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed 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
default_value	JSON	Optional
default_value (anyOf 1)	string	Alternative
default_value (anyOf 2)	integer	Alternative
default_value (anyOf 3)	number	Alternative
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
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: workflow Default: workflow
workflow_parameter_type	string	Required within parent	One of: string, integer, float, boolean, json, file_url, credential_id

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition retry policy webhook on retry: final only, every attempt

Field	Type	Presence	Description and constraints
$	object	Root
delay_seconds	integer	Optional	Fixed delay before the next attempt, in seconds Default: 0 Maximum: 3600.0 Minimum: 0.0
max_retries	integer	Optional	Maximum number of retries after the initial attempt Default: 1 Maximum: 5.0 Minimum: 1.0
retry_on	array	Required within parent	Terminal status rules that enable retries Minimum items: 1
retry_on[]	Model	Each item	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed 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 Default: final_only One of: final_only, every_attempt

Referenced models: Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition retry policy webhook on retry: final only, every attempt retry on item

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed 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. One of: completed, failed, terminated, canceled, timed_out

Update an agent — response body

Field	Type	Presence	Description and constraints
$	object	Root
adaptive_caching	boolean	Optional	Default: false
agent_id	string	Required within parent	Alias of `workflow_permanent_id` — the stable agent identifier (starts with `wpid_`). Read only: true
ai_fallback	boolean	Optional	Default: true
browser_profile_id	JSON	Optional
browser_profile_id (anyOf 1)	string	Alternative
browser_profile_id (anyOf 2)	null	Alternative
browser_profile_key	JSON	Optional
browser_profile_key (anyOf 1)	string	Alternative
browser_profile_key (anyOf 2)	null	Alternative
browser_type	JSON	Optional
browser_type (anyOf 1)	string	Alternative
browser_type (anyOf 2)	null	Alternative
build_source	JSON	Optional	Which surface wrote this version: ui, copilot, mcp, cli, api, or internal. Null before tracking began.
build_source (anyOf 1)	string	Alternative	Which surface wrote a workflow version. - ui: the Skyvern app - copilot: the workflow copilot - mcp: a first-party MCP client - cli: the Skyvern CLI - api: any other API or SDK caller - internal: a workflow Skyvern creates for its own runs (task v2, login, credential tests) Known values: ui, copilot, mcp, cli, api, internal
build_source (anyOf 2)	null	Alternative
cache_key	JSON	Optional
cache_key (anyOf 1)	string	Alternative
cache_key (anyOf 2)	null	Alternative
cdp_connect_headers	JSON	Optional
cdp_connect_headers (anyOf 1)	object	Alternative	Additional keys: see wildcard field
cdp_connect_headers (anyOf 1).*	string	Additional keys
cdp_connect_headers (anyOf 2)	null	Alternative
code_version	JSON	Optional
code_version (anyOf 1)	JSON	Alternative
code_version (anyOf 1) (anyOf 1)	integer	Alternative
code_version (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
code_version (anyOf 2)	null	Alternative
copilot_authored	boolean	Optional	Default: false
created_at	string	Required within parent	Format: date-time
created_by	JSON	Optional
created_by (anyOf 1)	string	Alternative
created_by (anyOf 2)	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
edited_by	JSON	Optional
edited_by (anyOf 1)	string	Alternative
edited_by (anyOf 2)	null	Alternative
effective_default_engine	JSON	Optional	The engine a task block with no `engine` set runs on in this agent, or null when engine routing decides it. Populated by the detail endpoint only.
effective_default_engine (anyOf 1)	string	Alternative	Known values: skyvern-1.0, skyvern-2.0, skyvern-3.0, openai-cua, anthropic-cua, ui-tars, yutori-navigator
effective_default_engine (anyOf 2)	null	Alternative
enable_self_healing	boolean	Optional	Default: false
extra_http_headers	JSON	Optional
extra_http_headers (anyOf 1)	object	Alternative	Additional keys: see wildcard field
extra_http_headers (anyOf 1).*	string	Additional keys
extra_http_headers (anyOf 2)	null	Alternative
folder_id	JSON	Optional
folder_id (anyOf 1)	string	Alternative
folder_id (anyOf 2)	null	Alternative
generate_script_on_terminal	boolean	Optional	Default: false
import_error	JSON	Optional
import_error (anyOf 1)	string	Alternative
import_error (anyOf 2)	null	Alternative
is_saved_task	boolean	Required within parent
is_template	boolean	Optional	Default: false
mask_secrets	boolean	Optional	Default: false
max_elapsed_time_minutes	JSON	Optional
max_elapsed_time_minutes (anyOf 1)	JSON	Alternative
max_elapsed_time_minutes (anyOf 1) (anyOf 1)	integer	Alternative
max_elapsed_time_minutes (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_elapsed_time_minutes (anyOf 2)	null	Alternative
max_screenshot_scrolls	JSON	Optional
max_screenshot_scrolls (anyOf 1)	JSON	Alternative
max_screenshot_scrolls (anyOf 1) (anyOf 1)	integer	Alternative
max_screenshot_scrolls (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_screenshot_scrolls (anyOf 2)	null	Alternative
model	JSON	Optional
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
modified_at	string	Required within parent	Format: date-time
organization_id	string	Required within parent
original_created_at	JSON	Optional	When the agent's first version was created. Populated by the list endpoint only.
original_created_at (anyOf 1)	string	Alternative	Format: date-time
original_created_at (anyOf 2)	null	Alternative
original_created_by	JSON	Optional	Who created the agent's first version. Populated by the list endpoint only.
original_created_by (anyOf 1)	string	Alternative
original_created_by (anyOf 2)	null	Alternative
persist_browser_session	boolean	Optional	Default: false
pin_saved_session_ip	boolean	Optional	Default: false
proxy_location	JSON	Optional
proxy_location (anyOf 1)	Model	Alternative	Expand Update an agent — response body — proxy location string
proxy_location (anyOf 2)	Model	Alternative	Expand Update an agent — response body — proxy location city, country, is ISP, subdivision
proxy_location (anyOf 3)	object	Alternative	Additional keys: allowed
proxy_location (anyOf 4)	null	Alternative
reuse_browser_session	boolean	Optional	Default: false
run_sequentially	JSON	Optional
run_sequentially (anyOf 1)	boolean	Alternative
run_sequentially (anyOf 2)	null	Alternative
run_with	string	Optional	Default: agent
sequential_key	JSON	Optional
sequential_key (anyOf 1)	string	Alternative
sequential_key (anyOf 2)	null	Alternative
status	string	Optional	Known values: published, draft, auto_generated, importing, import_failed Default: published
title	string	Required within parent
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
version	JSON	Required within parent
version (anyOf 1)	integer	Alternative
version (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
webhook_callback_url	JSON	Optional
webhook_callback_url (anyOf 1)	string	Alternative
webhook_callback_url (anyOf 2)	null	Alternative
workflow_definition	Model	Required within parent	Expand Update an agent — response body — workflow definition
workflow_id	string	Required within parent
workflow_permanent_id	string	Required within parent

Referenced models: Update an agent — response body — proxy location city, country, is ISP, subdivision, Update an agent — response body — proxy location string, Update an agent — response body — workflow definition

Update an agent — response body — proxy location city, country, is ISP, subdivision

Field	Type	Presence	Description and constraints
$	object	Root	Granular proxy geo-targeting request with country, optional subdivision, and optional city.
city	JSON	Optional	City name in English from GeoNames (e.g., 'New York', 'Los Angeles', 'London')
city (anyOf 1)	string	Alternative	Maximum length: 100
city (anyOf 2)	null	Alternative
country	string	Required within parent	ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'DE') Maximum length: 2 Minimum length: 2
isISP	boolean	Optional	Whether this geo target is marked as an ISP proxy location. Default: false
subdivision	JSON	Optional	ISO 3166-2 subdivision code without country prefix (e.g., 'CA' for California, 'NY' for New York)
subdivision (anyOf 1)	string	Alternative	Maximum length: 10
subdivision (anyOf 2)	null	Alternative

Update an agent — response body — proxy location string

Field	Type	Presence	Description and constraints
$	string	Root	Known values: 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

Update an agent — response body — workflow definition

Field	Type	Presence	Description and constraints
$	object	Root
blocks	array	Required within parent
blocks[]	JSON	Each item
blocks[] (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type conditional
blocks[] (anyOf 2)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type for loop
blocks[] (anyOf 3)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type while loop
blocks[] (anyOf 4)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type task
blocks[] (anyOf 5)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type code
blocks[] (anyOf 6)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type text prompt
blocks[] (anyOf 7)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type download to s3
blocks[] (anyOf 8)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type upload to s3
blocks[] (anyOf 9)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type send_email, body_format: text, html
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
blocks[] (anyOf 11)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type pdf parser
blocks[] (anyOf 12)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type validation
blocks[] (anyOf 13)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / ai_fallback: fallback, proactive, block type action
blocks[] (anyOf 14)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type navigation
blocks[] (anyOf 15)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type extraction
blocks[] (anyOf 16)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type login
blocks[] (anyOf 17)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type wait
blocks[] (anyOf 18)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type human_interaction, body_format: text, html
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
blocks[] (anyOf 20)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type goto url
blocks[] (anyOf 21)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type task v2
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
blocks[] (anyOf 23)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type http request
blocks[] (anyOf 24)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type web_search, provider: auto, google, exa
blocks[] (anyOf 25)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type print page
blocks[] (anyOf 26)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type workflow trigger
blocks[] (anyOf 27)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type google sheets read
blocks[] (anyOf 28)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type email_inbox, email_client: gmail, outlook
blocks[] (anyOf 29)	Model	Alternative	Expand Update an agent — response body — workflow_definition / blocks / item / block_type google_sheets_write, write_mode: append, update
blocks[] (anyOf 30)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type powerbi query
blocks[] (anyOf 31)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type pdf fill
blocks[] (anyOf 32)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type split pdf
blocks[] (anyOf 33)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type data export
blocks[] (anyOf 34)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type terminate
blocks[] (anyOf 35)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type agent step
browser_settings	JSON	Optional	Settings applied to every browser this workflow version creates.
browser_settings (anyOf 1)	Model	Alternative	Expand Get a session — response body — browser settings timezone id
browser_settings (anyOf 2)	null	Alternative
completion_contract	JSON	Optional	Copilot-managed: what a run of this workflow must produce, graded at run finalization. Derived from the request when a workflow is accepted; not intended to be authored by hand.
completion_contract (anyOf 1)	object	Alternative	Additional keys: allowed
completion_contract (anyOf 2)	null	Alternative
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
finally_block_label	JSON	Optional
finally_block_label (anyOf 1)	string	Alternative
finally_block_label (anyOf 2)	null	Alternative
parameters	array	Required within parent
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
retry_policy	JSON	Optional	Optional policy for retrying eligible terminal workflow runs
retry_policy (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow_definition / retry_policy / webhook_on_retry: final only, every attempt
retry_policy (anyOf 2)	null	Alternative
version	JSON	Optional
version (anyOf 1)	integer	Alternative	Default: 1
version (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
workflow_system_prompt	JSON	Optional
workflow_system_prompt (anyOf 1)	string	Alternative
workflow_system_prompt (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, Get a session — response body — browser settings timezone id, Update an agent — response body — workflow definition parameters item parameter type credential, Update an agent — response body — workflow definition blocks item block type download to s3, Update an agent — response body — workflow definition parameters item parameter type onepassword, 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 parameters item parameter type context, 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 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 / parameters / item / parameter_type workflow, workflow_parameter_type: 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, Update an agent — response body — workflow definition blocks item block type workflow trigger

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

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: agent_step Default: agent_step
continue_on_failure	boolean	Optional	Default: false
data_schema	object	Required within parent	Additional keys: allowed
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.
max_turns	JSON	Optional
max_turns (anyOf 1)	integer	Alternative	Default: 25
max_turns (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
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	string	Required within parent
tools	JSON	Optional
tools (anyOf 1)	array	Alternative
tools (anyOf 1)[]	string	Each item
tools (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 code

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: code Default: code
code	string	Required within parent
code_edited_by_hand	JSON	Optional
code_edited_by_hand (anyOf 1)	boolean	Alternative
code_edited_by_hand (anyOf 2)	null	Alternative
continue_on_failure	boolean	Optional	Default: false
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
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
goal_needs_regeneration	JSON	Optional
goal_needs_regeneration (anyOf 1)	boolean	Alternative
goal_needs_regeneration (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
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
steps	JSON	Optional
steps (anyOf 1)	array	Alternative
steps (anyOf 1)[]	Model	Each item	Expand Update an agent — response body — workflow definition blocks item block type code steps array item
steps (anyOf 2)	null	Alternative
user_owned_goal	JSON	Optional
user_owned_goal (anyOf 1)	boolean	Alternative
user_owned_goal (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 blocks item block type code steps array item, 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 code steps array item

Field	Type	Presence	Description and constraints
$	object	Root
action_type	string	Optional	Known values: click, input_text, paste_text, upload_file, download_file, select_option, checkbox, wait, hover, null_action, solve_captcha, terminate, complete, reload_page, close_page, new_tab, switch_tab, extract, verification_code, goto_url, go_back, go_forward, scroll, keypress, move, drag, left_mouse, execute_js Default: null_action
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
line_end	JSON	Optional
line_end (anyOf 1)	JSON	Alternative
line_end (anyOf 1) (anyOf 1)	integer	Alternative
line_end (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
line_end (anyOf 2)	null	Alternative
line_start	JSON	Optional
line_start (anyOf 1)	JSON	Alternative
line_start (anyOf 1) (anyOf 1)	integer	Alternative
line_start (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
line_start (anyOf 2)	null	Alternative

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

Field	Type	Presence	Description and constraints
$	object	Root	Branching block that selects the next block label based on list-ordered conditions.
block_type	string	Required within parent	Must equal: conditional Default: conditional
branch_conditions	array	Optional
branch_conditions[]	Model	Each item	Expand Update an agent — response body — workflow definition blocks item block type conditional branch conditions item
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

Referenced models: Update an agent — response body — workflow definition blocks item block type conditional branch conditions item, Update an agent — response body — workflow definition parameters item parameter type output

Update an agent — response body — workflow definition blocks item block type conditional branch conditions item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single conditional branch edge within a ConditionalBlock.
criteria	JSON	Optional
criteria (anyOf 1)	JSON	Alternative
criteria (anyOf 1) (anyOf 1)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type while loop condition criteria type jinja2 template
criteria (anyOf 1) (anyOf 2)	Model	Alternative	Expand Update an agent — response body — workflow definition blocks item block type while loop condition criteria type prompt
criteria (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
id	string	Optional
is_default	boolean	Optional	Default: false
next_block_label	JSON	Optional
next_block_label (anyOf 1)	string	Alternative
next_block_label (anyOf 2)	null	Alternative

Referenced models: 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 block type while loop condition criteria type prompt

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

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: data_export Default: data_export
continue_on_failure	boolean	Optional	Default: false
data	string	Required within parent
data_schema	object	Required within parent	Additional keys: allowed
disable_cache	boolean	Optional	Default: false
file_name	JSON	Optional
file_name (anyOf 1)	string	Alternative
file_name (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
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

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 download to s3

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: download_to_s3 Default: download_to_s3
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
url	string	Required within parent

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 extraction

Field	Type	Presence	Description and constraints
$	object	Root
block_type	string	Required within parent	Must equal: extraction Default: extraction
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	string	Required within parent
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
export_data_schema	JSON	Optional
export_data_schema (anyOf 1)	object	Alternative	Additional keys: allowed
export_data_schema (anyOf 2)	null	Alternative
export_enabled	boolean	Optional	Default: false
export_file_name	JSON	Optional
export_file_name (anyOf 1)	string	Alternative
export_file_name (anyOf 2)	null	Alternative
export_records	JSON	Optional
export_records (anyOf 1)	string	Alternative
export_records (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: false
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
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