Skip to content

Skyvern: Agents schemas (part 3)

18 Skyvern schemas with complete fields and constraints.

← Agents operations · All schemas

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

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: for_loop
Default: for_loop
complete_if_emptybooleanOptionalDefault: false
continue_on_failurebooleanOptionalDefault: false
data_schemaJSONOptional
data_schema (anyOf 1)objectAlternativeAdditional keys: allowed
data_schema (anyOf 2)stringAlternative
data_schema (anyOf 3)nullAlternative
disable_cachebooleanOptionalDefault: false
ignore_workflow_system_promptbooleanOptionalDefault: false
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
loop_blocksarrayRequired within parent
loop_blocks[]JSONEach item
loop_blocks[] (anyOf 1)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type conditional
loop_blocks[] (anyOf 2)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type for loop
loop_blocks[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type while loop
loop_blocks[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type task
loop_blocks[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type code
loop_blocks[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type text prompt
loop_blocks[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type download to s3
loop_blocks[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type upload to s3
loop_blocks[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow_definition / blocks / item / block_type send_email, body_format: text, html
loop_blocks[] (anyOf 10)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type pdf parser
loop_blocks[] (anyOf 12)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type validation
loop_blocks[] (anyOf 13)ModelAlternativeExpand Update an agent — response body — workflow_definition / blocks / item / ai_fallback: fallback, proactive, block type action
loop_blocks[] (anyOf 14)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type navigation
loop_blocks[] (anyOf 15)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type extraction
loop_blocks[] (anyOf 16)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type login
loop_blocks[] (anyOf 17)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type wait
loop_blocks[] (anyOf 18)ModelAlternativeExpand Update an agent — response body — workflow_definition / blocks / item / block_type human_interaction, body_format: text, html
loop_blocks[] (anyOf 19)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type goto url
loop_blocks[] (anyOf 21)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type task v2
loop_blocks[] (anyOf 22)ModelAlternativeExpand Update an agent — response body — workflow_definition / blocks / item / block_type file_upload, storage_type: s3, azure, google drive, sftp
loop_blocks[] (anyOf 23)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type http request
loop_blocks[] (anyOf 24)ModelAlternativeExpand Update an agent — response body — workflow_definition / blocks / item / block_type web_search, provider: auto, google, exa
loop_blocks[] (anyOf 25)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type print page
loop_blocks[] (anyOf 26)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type workflow trigger
loop_blocks[] (anyOf 27)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type google sheets read
loop_blocks[] (anyOf 28)ModelAlternativeExpand Update an agent — response body — workflow_definition / blocks / item / block_type email_inbox, email_client: gmail, outlook
loop_blocks[] (anyOf 29)ModelAlternativeExpand Update an agent — response body — workflow_definition / blocks / item / block_type google_sheets_write, write_mode: append, update
loop_blocks[] (anyOf 30)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type powerbi query
loop_blocks[] (anyOf 31)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type pdf fill
loop_blocks[] (anyOf 32)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type split pdf
loop_blocks[] (anyOf 33)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type data export
loop_blocks[] (anyOf 34)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type terminate
loop_blocks[] (anyOf 35)ModelAlternativeExpand Update an agent — response body — workflow definition blocks item block type agent step
loop_overJSONOptional
loop_over (anyOf 1)JSONAlternative
loop_over (anyOf 1) (anyOf 1)ModelAlternativeExpand Update an agent — response body — workflow_definition / parameters / item / parameter_type workflow, workflow_parameter_type: string, integer, float, boolean, json, file url, credential id
loop_over (anyOf 1) (anyOf 2)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
loop_over (anyOf 1) (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
loop_over (anyOf 1) (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
loop_over (anyOf 1) (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
loop_over (anyOf 1) (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
loop_over (anyOf 1) (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
loop_over (anyOf 1) (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
loop_over (anyOf 1) (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
loop_over (anyOf 1) (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
loop_over (anyOf 1) (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
loop_over (anyOf 2)nullAlternative
loop_variable_referenceJSONOptional
loop_variable_reference (anyOf 1)stringAlternative
loop_variable_reference (anyOf 2)nullAlternative
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output

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 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 blocks item block type workflow trigger

Update an agent — response body — workflow definition blocks item block type google sheets read

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: google_sheets_read
Default: google_sheets_read
continue_on_failurebooleanOptionalDefault: false
credential_idJSONOptional
credential_id (anyOf 1)stringAlternative
credential_id (anyOf 2)nullAlternative
disable_cachebooleanOptionalDefault: false
has_header_rowbooleanOptionalDefault: true
ignore_workflow_system_promptbooleanOptionalDefault: false
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
rangeJSONOptional
range (anyOf 1)stringAlternative
range (anyOf 2)nullAlternative
sheet_nameJSONOptional
sheet_name (anyOf 1)stringAlternative
sheet_name (anyOf 2)nullAlternative
spreadsheet_urlstringRequired 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 blocks item block type goto url

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: goto_url
Default: goto_url
complete_criterionJSONOptional
complete_criterion (anyOf 1)stringAlternative
complete_criterion (anyOf 2)nullAlternative
complete_criterion_is_untrustedbooleanOptionalDefault: false
complete_on_downloadbooleanOptionalDefault: false
complete_verificationbooleanOptionalDefault: true
continue_on_failurebooleanOptionalDefault: false
data_extraction_goalJSONOptional
data_extraction_goal (anyOf 1)stringAlternative
data_extraction_goal (anyOf 2)nullAlternative
data_schemaJSONOptional
data_schema (anyOf 1)objectAlternativeAdditional keys: allowed
data_schema (anyOf 2)arrayAlternative
data_schema (anyOf 2)[]JSONEach item
data_schema (anyOf 3)stringAlternative
data_schema (anyOf 4)nullAlternative
disable_cachebooleanOptionalDefault: false
download_suffixJSONOptional
download_suffix (anyOf 1)stringAlternative
download_suffix (anyOf 2)nullAlternative
download_timeoutJSONOptional
download_timeout (anyOf 1)JSONAlternative
download_timeout (anyOf 1) (anyOf 1)numberAlternative
download_timeout (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
download_timeout (anyOf 2)nullAlternative
engineJSONOptionalDefault: skyvern-1.0
engine (anyOf 1)stringAlternativeKnown values: skyvern-1.0, skyvern-2.0, skyvern-3.0, openai-cua, anthropic-cua, ui-tars, yutori-navigator
engine (anyOf 2)nullAlternative
engine_pinnedbooleanOptionalDefault: false
error_code_mappingJSONOptional
error_code_mapping (anyOf 1)objectAlternativeAdditional keys: see wildcard field
error_code_mapping (anyOf 1).*stringAdditional keys
error_code_mapping (anyOf 2)nullAlternative
ignore_workflow_system_promptbooleanOptionalDefault: false
include_action_history_in_verificationbooleanOptionalDefault: false
include_extracted_textbooleanOptionalDefault: true
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
max_retriesJSONOptional
max_retries (anyOf 1)integerAlternativeDefault: 0
max_retries (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_runJSONOptional
max_steps_per_run (anyOf 1)JSONAlternative
max_steps_per_run (anyOf 1) (anyOf 1)integerAlternative
max_steps_per_run (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_run (anyOf 2)nullAlternative
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
navigation_goalJSONOptional
navigation_goal (anyOf 1)stringAlternative
navigation_goal (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
task_typestringOptionalDefault: general
terminate_criterionJSONOptional
terminate_criterion (anyOf 1)stringAlternative
terminate_criterion (anyOf 2)nullAlternative
titlestringOptionalDefault:
totp_identifierJSONOptional
totp_identifier (anyOf 1)stringAlternative
totp_identifier (anyOf 2)nullAlternative
totp_verification_urlJSONOptional
totp_verification_url (anyOf 1)stringAlternative
totp_verification_url (anyOf 2)nullAlternative
urlstringRequired 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 blocks item block type http request

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: http_request
Default: http_request
bodyJSONOptional
body (anyOf 1)objectAlternativeAdditional keys: allowed
body (anyOf 2)nullAlternative
continue_on_failurebooleanOptionalDefault: false
disable_cachebooleanOptionalDefault: false
download_filenameJSONOptional
download_filename (anyOf 1)stringAlternative
download_filename (anyOf 2)nullAlternative
filesJSONOptional
files (anyOf 1)objectAlternativeAdditional keys: see wildcard field
files (anyOf 1).*stringAdditional keys
files (anyOf 2)nullAlternative
follow_redirectsbooleanOptionalDefault: true
headersJSONOptional
headers (anyOf 1)objectAlternativeAdditional keys: see wildcard field
headers (anyOf 1).*stringAdditional keys
headers (anyOf 2)nullAlternative
ignore_workflow_system_promptbooleanOptionalDefault: false
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
methodstringOptionalDefault: GET
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
save_response_as_filebooleanOptionalDefault: false
secret_response_pathsJSONOptional
secret_response_paths (anyOf 1)arrayAlternative
secret_response_paths (anyOf 1)[]stringEach item
secret_response_paths (anyOf 2)nullAlternative
timeoutJSONOptional
timeout (anyOf 1)integerAlternativeDefault: 30
timeout (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
urlJSONOptional
url (anyOf 1)stringAlternative
url (anyOf 2)nullAlternative

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 login

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: login
Default: login
complete_criterionJSONOptional
complete_criterion (anyOf 1)stringAlternative
complete_criterion (anyOf 2)nullAlternative
complete_criterion_is_untrustedbooleanOptionalDefault: false
complete_on_downloadbooleanOptionalDefault: false
complete_verificationbooleanOptionalDefault: true
continue_on_failurebooleanOptionalDefault: false
data_extraction_goalJSONOptional
data_extraction_goal (anyOf 1)stringAlternative
data_extraction_goal (anyOf 2)nullAlternative
data_schemaJSONOptional
data_schema (anyOf 1)objectAlternativeAdditional keys: allowed
data_schema (anyOf 2)arrayAlternative
data_schema (anyOf 2)[]JSONEach item
data_schema (anyOf 3)stringAlternative
data_schema (anyOf 4)nullAlternative
disable_cachebooleanOptionalDefault: false
download_suffixJSONOptional
download_suffix (anyOf 1)stringAlternative
download_suffix (anyOf 2)nullAlternative
download_timeoutJSONOptional
download_timeout (anyOf 1)JSONAlternative
download_timeout (anyOf 1) (anyOf 1)numberAlternative
download_timeout (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
download_timeout (anyOf 2)nullAlternative
engineJSONOptional
engine (anyOf 1)stringAlternativeKnown values: skyvern-1.0, skyvern-2.0, skyvern-3.0, openai-cua, anthropic-cua, ui-tars, yutori-navigator
engine (anyOf 2)nullAlternative
engine_pinnedbooleanOptionalDefault: false
error_code_mappingJSONOptional
error_code_mapping (anyOf 1)objectAlternativeAdditional keys: see wildcard field
error_code_mapping (anyOf 1).*stringAdditional keys
error_code_mapping (anyOf 2)nullAlternative
ignore_workflow_system_promptbooleanOptionalDefault: false
include_action_history_in_verificationbooleanOptionalDefault: false
include_extracted_textbooleanOptionalDefault: true
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
max_retriesJSONOptional
max_retries (anyOf 1)integerAlternativeDefault: 0
max_retries (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_runJSONOptional
max_steps_per_run (anyOf 1)JSONAlternative
max_steps_per_run (anyOf 1) (anyOf 1)integerAlternative
max_steps_per_run (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_run (anyOf 2)nullAlternative
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
navigation_goalJSONOptional
navigation_goal (anyOf 1)stringAlternative
navigation_goal (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
skip_saved_profilebooleanOptionalDefault: false
task_typestringOptionalDefault: general
terminate_criterionJSONOptional
terminate_criterion (anyOf 1)stringAlternative
terminate_criterion (anyOf 2)nullAlternative
titlestringOptionalDefault:
totp_identifierJSONOptional
totp_identifier (anyOf 1)stringAlternative
totp_identifier (anyOf 2)nullAlternative
totp_verification_urlJSONOptional
totp_verification_url (anyOf 1)stringAlternative
totp_verification_url (anyOf 2)nullAlternative
urlJSONOptional
url (anyOf 1)stringAlternative
url (anyOf 2)nullAlternative

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 navigation

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: navigation
Default: navigation
complete_criterionJSONOptional
complete_criterion (anyOf 1)stringAlternative
complete_criterion (anyOf 2)nullAlternative
complete_criterion_is_untrustedbooleanOptionalDefault: false
complete_on_downloadbooleanOptionalDefault: false
complete_verificationbooleanOptionalDefault: true
continue_on_failurebooleanOptionalDefault: false
data_extraction_goalJSONOptional
data_extraction_goal (anyOf 1)stringAlternative
data_extraction_goal (anyOf 2)nullAlternative
data_schemaJSONOptional
data_schema (anyOf 1)objectAlternativeAdditional keys: allowed
data_schema (anyOf 2)arrayAlternative
data_schema (anyOf 2)[]JSONEach item
data_schema (anyOf 3)stringAlternative
data_schema (anyOf 4)nullAlternative
disable_cachebooleanOptionalDefault: false
download_suffixJSONOptional
download_suffix (anyOf 1)stringAlternative
download_suffix (anyOf 2)nullAlternative
download_timeoutJSONOptional
download_timeout (anyOf 1)JSONAlternative
download_timeout (anyOf 1) (anyOf 1)numberAlternative
download_timeout (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
download_timeout (anyOf 2)nullAlternative
engineJSONOptional
engine (anyOf 1)stringAlternativeKnown values: skyvern-1.0, skyvern-2.0, skyvern-3.0, openai-cua, anthropic-cua, ui-tars, yutori-navigator
engine (anyOf 2)nullAlternative
engine_pinnedbooleanOptionalDefault: false
error_code_mappingJSONOptional
error_code_mapping (anyOf 1)objectAlternativeAdditional keys: see wildcard field
error_code_mapping (anyOf 1).*stringAdditional keys
error_code_mapping (anyOf 2)nullAlternative
ignore_workflow_system_promptbooleanOptionalDefault: false
include_action_history_in_verificationbooleanOptionalDefault: false
include_extracted_textbooleanOptionalDefault: true
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
max_retriesJSONOptional
max_retries (anyOf 1)integerAlternativeDefault: 0
max_retries (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_runJSONOptional
max_steps_per_run (anyOf 1)JSONAlternative
max_steps_per_run (anyOf 1) (anyOf 1)integerAlternative
max_steps_per_run (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_run (anyOf 2)nullAlternative
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
navigation_goalstringRequired within parent
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
task_typestringOptionalDefault: general
terminate_criterionJSONOptional
terminate_criterion (anyOf 1)stringAlternative
terminate_criterion (anyOf 2)nullAlternative
titlestringOptionalDefault:
totp_identifierJSONOptional
totp_identifier (anyOf 1)stringAlternative
totp_identifier (anyOf 2)nullAlternative
totp_verification_urlJSONOptional
totp_verification_url (anyOf 1)stringAlternative
totp_verification_url (anyOf 2)nullAlternative
urlJSONOptional
url (anyOf 1)stringAlternative
url (anyOf 2)nullAlternative

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 pdf fill

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: pdf_fill
Default: pdf_fill
continue_on_failurebooleanOptionalDefault: false
disable_cachebooleanOptionalDefault: false
file_urlstringRequired within parent
ignore_workflow_system_promptbooleanOptionalDefault: false
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
llm_keyJSONOptional
llm_key (anyOf 1)stringAlternative
llm_key (anyOf 2)nullAlternative
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
payloadJSONOptional
payload (anyOf 1)objectAlternativeAdditional keys: allowed
payload (anyOf 2)arrayAlternative
payload (anyOf 2)[]JSONEach item
payload (anyOf 3)stringAlternative
payload (anyOf 4)nullAlternative
promptstringRequired 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 blocks item block type pdf parser

FieldTypePresenceDescription and constraints
$objectRootDEPRECATED: Use FileParserBlock with file_type=FileType.PDF instead.
This block will be removed in a future version.
block_typestringRequired within parentMust equal: pdf_parser
Default: pdf_parser
continue_on_failurebooleanOptionalDefault: false
disable_cachebooleanOptionalDefault: false
file_urlstringRequired within parent
ignore_workflow_system_promptbooleanOptionalDefault: false
json_schemaJSONOptional
json_schema (anyOf 1)objectAlternativeAdditional keys: allowed
json_schema (anyOf 2)nullAlternative
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output

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 powerbi query

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: powerbi_query
Default: powerbi_query
connection_idstringRequired within parent
continue_on_failurebooleanOptionalDefault: false
dataset_idstringRequired within parent
disable_cachebooleanOptionalDefault: false
ignore_workflow_system_promptbooleanOptionalDefault: false
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
max_rowsJSONOptional
max_rows (anyOf 1)integerAlternativeDefault: 1000
Maximum: 100000.0
Minimum: 1.0
max_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
querystringRequired 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 blocks item block type print page

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: print_page
Default: print_page
continue_on_failurebooleanOptionalDefault: false
custom_filenameJSONOptional
custom_filename (anyOf 1)stringAlternative
custom_filename (anyOf 2)nullAlternative
disable_cachebooleanOptionalDefault: false
formatstringOptionalDefault: A4
ignore_workflow_system_promptbooleanOptionalDefault: false
include_timestampbooleanOptionalDefault: true
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
landscapebooleanOptionalDefault: false
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
print_backgroundbooleanOptionalDefault: true

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 split pdf

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: split_pdf
Default: split_pdf
continue_on_failurebooleanOptionalDefault: false
disable_cachebooleanOptionalDefault: false
file_urlstringRequired within parent
ignore_workflow_system_promptbooleanOptionalDefault: false
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
llm_keyJSONOptional
llm_key (anyOf 1)stringAlternative
llm_key (anyOf 2)nullAlternative
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
promptstringRequired 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 blocks item block type task

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: task
Default: task
complete_criterionJSONOptional
complete_criterion (anyOf 1)stringAlternative
complete_criterion (anyOf 2)nullAlternative
complete_criterion_is_untrustedbooleanOptionalDefault: false
complete_on_downloadbooleanOptionalDefault: false
complete_verificationbooleanOptionalDefault: true
continue_on_failurebooleanOptionalDefault: false
data_extraction_goalJSONOptional
data_extraction_goal (anyOf 1)stringAlternative
data_extraction_goal (anyOf 2)nullAlternative
data_schemaJSONOptional
data_schema (anyOf 1)objectAlternativeAdditional keys: allowed
data_schema (anyOf 2)arrayAlternative
data_schema (anyOf 2)[]JSONEach item
data_schema (anyOf 3)stringAlternative
data_schema (anyOf 4)nullAlternative
disable_cachebooleanOptionalDefault: false
download_suffixJSONOptional
download_suffix (anyOf 1)stringAlternative
download_suffix (anyOf 2)nullAlternative
download_timeoutJSONOptional
download_timeout (anyOf 1)JSONAlternative
download_timeout (anyOf 1) (anyOf 1)numberAlternative
download_timeout (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
download_timeout (anyOf 2)nullAlternative
engineJSONOptional
engine (anyOf 1)stringAlternativeKnown values: skyvern-1.0, skyvern-2.0, skyvern-3.0, openai-cua, anthropic-cua, ui-tars, yutori-navigator
engine (anyOf 2)nullAlternative
engine_pinnedbooleanOptionalDefault: false
error_code_mappingJSONOptional
error_code_mapping (anyOf 1)objectAlternativeAdditional keys: see wildcard field
error_code_mapping (anyOf 1).*stringAdditional keys
error_code_mapping (anyOf 2)nullAlternative
ignore_workflow_system_promptbooleanOptionalDefault: false
include_action_history_in_verificationbooleanOptionalDefault: false
include_extracted_textbooleanOptionalDefault: true
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
max_retriesJSONOptional
max_retries (anyOf 1)integerAlternativeDefault: 0
max_retries (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_runJSONOptional
max_steps_per_run (anyOf 1)JSONAlternative
max_steps_per_run (anyOf 1) (anyOf 1)integerAlternative
max_steps_per_run (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_run (anyOf 2)nullAlternative
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
navigation_goalJSONOptional
navigation_goal (anyOf 1)stringAlternative
navigation_goal (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
task_typestringOptionalDefault: general
terminate_criterionJSONOptional
terminate_criterion (anyOf 1)stringAlternative
terminate_criterion (anyOf 2)nullAlternative
titlestringOptionalDefault:
totp_identifierJSONOptional
totp_identifier (anyOf 1)stringAlternative
totp_identifier (anyOf 2)nullAlternative
totp_verification_urlJSONOptional
totp_verification_url (anyOf 1)stringAlternative
totp_verification_url (anyOf 2)nullAlternative
urlJSONOptional
url (anyOf 1)stringAlternative
url (anyOf 2)nullAlternative

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 task v2

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: task_v2
Default: task_v2
continue_on_failurebooleanOptionalDefault: false
disable_cachebooleanOptionalDefault: false
ignore_workflow_system_promptbooleanOptionalDefault: false
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
max_iterationsJSONOptional
max_iterations (anyOf 1)integerAlternativeDefault: 50
max_iterations (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_stepsJSONOptional
max_steps (anyOf 1)integerAlternativeDefault: 25
max_steps (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
promptstringRequired within parent
totp_identifierJSONOptional
totp_identifier (anyOf 1)stringAlternative
totp_identifier (anyOf 2)nullAlternative
totp_verification_urlJSONOptional
totp_verification_url (anyOf 1)stringAlternative
totp_verification_url (anyOf 2)nullAlternative
urlJSONOptional
url (anyOf 1)stringAlternative
url (anyOf 2)nullAlternative

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 terminate

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: terminate
Default: terminate
continue_on_failurebooleanOptionalDefault: false
disable_cachebooleanOptionalDefault: false
error_codeJSONOptional
error_code (anyOf 1)stringAlternative
error_code (anyOf 2)nullAlternative
ignore_workflow_system_promptbooleanOptionalDefault: false
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
reasonstringRequired 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 text prompt

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: text_prompt
Default: text_prompt
continue_on_failurebooleanOptionalDefault: false
disable_cachebooleanOptionalDefault: false
ignore_workflow_system_promptbooleanOptionalDefault: false
json_schemaJSONOptional
json_schema (anyOf 1)objectAlternativeAdditional keys: allowed
json_schema (anyOf 2)nullAlternative
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
llm_keyJSONOptional
llm_key (anyOf 1)stringAlternative
llm_key (anyOf 2)nullAlternative
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
promptstringRequired 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 blocks item block type upload to s3

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: upload_to_s3
Default: upload_to_s3
continue_on_failurebooleanOptionalDefault: false
disable_cachebooleanOptionalDefault: false
ignore_workflow_system_promptbooleanOptionalDefault: false
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
pathJSONOptional
path (anyOf 1)stringAlternative
path (anyOf 2)nullAlternative

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 validation

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: validation
Default: validation
complete_criterionJSONOptional
complete_criterion (anyOf 1)stringAlternative
complete_criterion (anyOf 2)nullAlternative
complete_criterion_is_untrustedbooleanOptionalDefault: false
complete_on_downloadbooleanOptionalDefault: false
complete_verificationbooleanOptionalDefault: true
continue_on_failurebooleanOptionalDefault: false
data_extraction_goalJSONOptional
data_extraction_goal (anyOf 1)stringAlternative
data_extraction_goal (anyOf 2)nullAlternative
data_schemaJSONOptional
data_schema (anyOf 1)objectAlternativeAdditional keys: allowed
data_schema (anyOf 2)arrayAlternative
data_schema (anyOf 2)[]JSONEach item
data_schema (anyOf 3)stringAlternative
data_schema (anyOf 4)nullAlternative
disable_cachebooleanOptionalDefault: false
download_suffixJSONOptional
download_suffix (anyOf 1)stringAlternative
download_suffix (anyOf 2)nullAlternative
download_timeoutJSONOptional
download_timeout (anyOf 1)JSONAlternative
download_timeout (anyOf 1) (anyOf 1)numberAlternative
download_timeout (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
download_timeout (anyOf 2)nullAlternative
engineJSONOptional
engine (anyOf 1)stringAlternativeKnown values: skyvern-1.0, skyvern-2.0, skyvern-3.0, openai-cua, anthropic-cua, ui-tars, yutori-navigator
engine (anyOf 2)nullAlternative
engine_pinnedbooleanOptionalDefault: false
error_code_mappingJSONOptional
error_code_mapping (anyOf 1)objectAlternativeAdditional keys: see wildcard field
error_code_mapping (anyOf 1).*stringAdditional keys
error_code_mapping (anyOf 2)nullAlternative
ignore_workflow_system_promptbooleanOptionalDefault: false
include_action_history_in_verificationbooleanOptionalDefault: false
include_extracted_textbooleanOptionalDefault: true
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
max_retriesJSONOptional
max_retries (anyOf 1)integerAlternativeDefault: 0
max_retries (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_runJSONOptional
max_steps_per_run (anyOf 1)JSONAlternative
max_steps_per_run (anyOf 1) (anyOf 1)integerAlternative
max_steps_per_run (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_steps_per_run (anyOf 2)nullAlternative
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
navigation_goalJSONOptional
navigation_goal (anyOf 1)stringAlternative
navigation_goal (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
task_typestringOptionalDefault: general
terminate_criterionJSONOptional
terminate_criterion (anyOf 1)stringAlternative
terminate_criterion (anyOf 2)nullAlternative
titlestringOptionalDefault:
totp_identifierJSONOptional
totp_identifier (anyOf 1)stringAlternative
totp_identifier (anyOf 2)nullAlternative
totp_verification_urlJSONOptional
totp_verification_url (anyOf 1)stringAlternative
totp_verification_url (anyOf 2)nullAlternative
urlJSONOptional
url (anyOf 1)stringAlternative
url (anyOf 2)nullAlternative
without_page_informationbooleanOptionalDefault: false

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 wait

FieldTypePresenceDescription and constraints
$objectRoot
block_typestringRequired within parentMust equal: wait
Default: wait
continue_on_failurebooleanOptionalDefault: false
disable_cachebooleanOptionalDefault: false
ignore_workflow_system_promptbooleanOptionalDefault: false
labelstringRequired within parentAuthor-facing identifier for a block; unique within a workflow.
modelJSONOptional
model (anyOf 1)objectAlternativeAdditional keys: allowed
model (anyOf 2)nullAlternative
next_block_labelJSONOptionalOptional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted.
next_block_label (anyOf 1)stringAlternative
next_block_label (anyOf 2)nullAlternative
next_loop_on_failurebooleanOptionalDefault: false
output_parameterModelRequired within parentExpand Update an agent — response body — workflow definition parameters item parameter type output
parametersarrayOptionalDefault: []
parameters[]JSONEach item
parameters[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type context
parameters[] (anyOf 3)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type aws secret
parameters[] (anyOf 4)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure secret
parameters[] (anyOf 5)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden login credential
parameters[] (anyOf 6)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden sensitive information
parameters[] (anyOf 7)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type bitwarden credit card data
parameters[] (anyOf 8)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type onepassword
parameters[] (anyOf 9)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type azure vault credential
parameters[] (anyOf 10)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type output
parameters[] (anyOf 11)ModelAlternativeExpand Update an agent — response body — workflow definition parameters item parameter type credential
wait_secJSONRequired within parent
wait_sec (anyOf 1)integerAlternative
wait_sec (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.