Skyvern: Agents schemas (part 1)

32 Skyvern schemas with complete fields and constraints.

Update an agent — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`json_definition`	JSON	Optional	Workflow definition in JSON format
`json_definition (anyOf 1)`	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed
`json_definition (anyOf 2)`	null	Alternative
`yaml_definition`	JSON	Optional	Workflow definition in YAML format
`yaml_definition (anyOf 1)`	string	Alternative
`yaml_definition (anyOf 2)`	null	Alternative

Referenced models: Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed

Field	Type	Presence	Description and constraints
`$`	object	Root
`adaptive_caching`	boolean	Optional	Default: false
`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 engine for runs of this workflow, one of the supported browser types (e.g. msedge, chrome, stealth-chromium). A workflow-run setting overrides this. Null means the system default.
`browser_type (anyOf 1)`	string	Alternative
`browser_type (anyOf 2)`	null	Alternative
`cache_key`	JSON	Optional	Default: default
`cache_key (anyOf 1)`	string	Alternative
`cache_key (anyOf 2)`	null	Alternative
`cdp_connect_headers`	JSON	Optional	On PUT updates, omission keeps the stored value, null clears it, and a supplied value replaces it. An empty object ({}) clears the header map; each masked *** entry keeps the stored value for that key.
`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)`	integer	Alternative	Maximum: 2.0 Minimum: 1.0
`code_version (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`enable_self_healing`	JSON	Optional
`enable_self_healing (anyOf 1)`	boolean	Alternative
`enable_self_healing (anyOf 2)`	null	Alternative
`extra_http_headers`	JSON	Optional	On PUT updates, omission keeps the stored value, null clears it, and a supplied value replaces it. An empty object ({}) clears the header map. Values, including ***, are literal.
`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
`is_saved_task`	boolean	Optional	Default: false
`mask_secrets`	JSON	Optional	Mask secret values across this workflow's runs: hide them while they are typed (screenshots, recordings, live view) and redact them from stored artifacts, network logs, and LLM-bound text.
`mask_secrets (anyOf 1)`	boolean	Alternative
`mask_secrets (anyOf 2)`	null	Alternative
`max_elapsed_time_minutes`	JSON	Optional
`max_elapsed_time_minutes (anyOf 1)`	integer	Alternative	Maximum: 480.0 Minimum: 1.0
`max_elapsed_time_minutes (anyOf 2)`	null	Alternative
`max_screenshot_scrolls`	JSON	Optional
`max_screenshot_scrolls (anyOf 1)`	integer	Alternative
`max_screenshot_scrolls (anyOf 2)`	null	Alternative
`model`	JSON	Optional
`model (anyOf 1)`	object	Alternative	Additional keys: allowed
`model (anyOf 2)`	null	Alternative
`persist_browser_session`	boolean	Optional	Default: false
`pin_saved_session_ip`	boolean	Optional	Default: false
`proxy_location`	JSON	Optional	On PUT updates, omission keeps the stored value, null clears it, and a supplied value replaces it.
`proxy_location (anyOf 1)`	string	Alternative	One of: 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
`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`	boolean	Optional	Default: false
`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	One of: published, draft, auto_generated, importing, import_failed Default: published
`title`	string	Required within parent
`totp_identifier`	JSON	Optional	On PUT updates, omission keeps the stored value, null clears it, and a supplied value replaces it.
`totp_identifier (anyOf 1)`	string	Alternative
`totp_identifier (anyOf 2)`	null	Alternative
`totp_verification_url`	JSON	Optional	On PUT updates, omission keeps the stored value, null clears it, and a supplied value replaces it. URL validation errors identify the field and failure class without returning the URL or host.
`totp_verification_url (anyOf 1)`	string	Alternative
`totp_verification_url (anyOf 2)`	null	Alternative
`webhook_callback_url`	JSON	Optional	On PUT updates, omission keeps the stored value, null clears it, and a supplied value replaces it. URL validation errors identify the field and failure class without returning the URL or host.
`webhook_callback_url (anyOf 1)`	string	Alternative
`webhook_callback_url (anyOf 2)`	null	Alternative
`workflow_definition`	Model	Required within parent	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition

Referenced models: Update an agent — response body — proxy location city, country, is ISP, subdivision, Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`blocks`	array	Required within parent
`blocks[]`	JSON	Each item
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`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
`browser_settings`	JSON	Optional	Settings applied to every browser this workflow version creates. Omit to keep the previous version's settings; set to null to clear them.
`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[] (oneOf 1)`	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition parameters item parameter type aws secret
`parameters[] (oneOf 2)`	Model	Alternative	Expand 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
`parameters[] (oneOf 3)`	Model	Alternative	Expand 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
`parameters[] (oneOf 4)`	Model	Alternative	Expand 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
`parameters[] (oneOf 5)`	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition parameters item parameter type onepassword
`parameters[] (oneOf 6)`	Model	Alternative	Expand 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
`parameters[] (oneOf 7)`	Model	Alternative	Expand 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
`parameters[] (oneOf 8)`	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition parameters item parameter type context
`parameters[] (oneOf 9)`	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition parameters item parameter type output
`parameters[] (oneOf 10)`	Model	Alternative	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed 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 — 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_policy (anyOf 2)`	null	Alternative
`version`	JSON	Optional
`version (anyOf 1)`	integer	Alternative
`version (anyOf 2)`	null	Alternative
`workflow_system_prompt`	JSON	Optional
`workflow_system_prompt (anyOf 1)`	string	Alternative
`workflow_system_prompt (anyOf 2)`	null	Alternative

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`ai_fallback`	string	Optional	Controls how an action block uses a CSS/XPath selector relative to AI. - `fallback`: attempt the selector first; fall back to AI on failure. - `proactive`: always use AI; the selector (if any) is a hint only. When `selector` is None, both modes degrade to AI-only — the difference is purely semantic (whether the author expected to have a selector here). One of: fallback, proactive Default: fallback
`block_type`	string	Required within parent	Must equal: action Default: action
`complete_on_download`	boolean	Optional	Default: false
`continue_on_failure`	boolean	Optional	Default: false
`disable_cache`	boolean	Optional	Default: false
`download_suffix`	JSON	Optional
`download_suffix (anyOf 1)`	string	Alternative
`download_suffix (anyOf 2)`	null	Alternative
`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_retries`	integer	Optional	Default: 0
`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
`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 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
`selector`	JSON	Optional
`selector (anyOf 1)`	string	Alternative
`selector (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

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed 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	Optional	JSON Schema (type object) of the answer the step returns through its finish tool. Later blocks read the answer as {{ <label>_output.output }}. Additional keys: allowed
`ignore_workflow_system_prompt`	boolean	Optional	Default: false
`label`	string	Required within parent	Author-facing identifier; must be unique per workflow.
`max_turns`	integer	Optional	Model turns the step may take. When they run out, the step gets one more turn in which only finish runs. Default: 25 Maximum: 200.0 Minimum: 1.0
`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	Keys of the workflow parameters and earlier block outputs the step uses.
`parameter_keys (anyOf 1)`	array	Alternative
`parameter_keys (anyOf 1)[]`	string	Each item
`parameter_keys (anyOf 2)`	null	Alternative
`prompt`	string	Required within parent	What the step must work out or get done. Rendered as a Jinja template against the run's parameters and earlier block outputs before the step starts.
`tools`	JSON	Optional	The tools the step may call. A block it runs through run_block is named by its block type, such as http_request. finish and read_run_data are always offered, and login only when the run has a credential parameter. Without a list the step has no other tools.
`tools (anyOf 1)`	array	Alternative
`tools (anyOf 1)[]`	string	Each item
`tools (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 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	True when a person edited this block's code in the editor's code field since the Goal was last confirmed, so the Goal may no longer describe the code. Set by the editor; a value the copilot submits is ignored in favour of the stored one
`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	JSON schema of the object this block's return produces; keys match the return keys; null when the block returns nothing
`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
`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	True when a person edited the Goal and the code has not been rebuilt from it yet. Set by the editor or the workflow API; a value the copilot submits is ignored in favour of the stored one
`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; 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
`prompt`	JSON	Optional	Plain-language goal of this code block, shown as the block's Goal in the editor
`prompt (anyOf 1)`	string	Alternative
`prompt (anyOf 2)`	null	Alternative
`steps`	JSON	Optional	Plain-language step outline mapped to code line ranges; always rebuilt from the code on save, so any value sent is ignored
`steps (anyOf 1)`	array	Alternative
`steps (anyOf 1)[]`	Model	Each item	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type code steps array item
`steps (anyOf 2)`	null	Alternative
`user_owned_goal`	JSON	Optional	True when a person wrote this block's Goal, so copilot regenerations keep their text. Set by the editor or the workflow API; a value the copilot submits is ignored in favour of the stored one
`user_owned_goal (anyOf 1)`	boolean	Alternative
`user_owned_goal (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 code steps array item

Field	Type	Presence	Description and constraints
`$`	object	Root
`action_type`	string	Optional	Default: null_action
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`line_end`	JSON	Optional
`line_end (anyOf 1)`	integer	Alternative
`line_end (anyOf 2)`	null	Alternative
`line_start`	JSON	Optional
`line_start (anyOf 1)`	integer	Alternative
`line_start (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 conditional

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: conditional Default: conditional
`branch_conditions`	array	Optional
`branch_conditions[]`	Model	Each item	Expand Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed workflow definition blocks item block type conditional branch conditions item
`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

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`criteria`	JSON	Optional
`criteria (anyOf 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 while loop condition
`criteria (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`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

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

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

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
`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
`url`	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 email inbox, email client: gmail, outlook

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: email_inbox Default: email_inbox
`continue_on_failure`	boolean	Optional	Default: false
`credential_id`	JSON	Optional
`credential_id (anyOf 1)`	string	Alternative
`credential_id (anyOf 2)`	null	Alternative
`download_attachments`	boolean	Optional	Download non-inline attachments from matched emails for downstream blocks. Default: false
`email_client`	string	Required within parent	One of: gmail, outlook
`folder`	JSON	Optional
`folder (anyOf 1)`	string	Alternative
`folder (anyOf 2)`	null	Alternative
`ignore_workflow_system_prompt`	boolean	Optional	Default: false
`include_body`	boolean	Optional	Default: true
`label`	string	Required within parent	Author-facing identifier; must be unique per workflow.
`max_results`	integer	Optional	Default: 25
`model`	JSON	Optional
`model (anyOf 1)`	object	Alternative	Additional keys: allowed
`model (anyOf 2)`	null	Alternative
`newer_than_days`	JSON	Optional
`newer_than_days (anyOf 1)`	integer	Alternative
`newer_than_days (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`	JSON	Optional
`prompt (anyOf 1)`	string	Alternative
`prompt (anyOf 2)`	null	Alternative
`sender`	JSON	Optional
`sender (anyOf 1)`	string	Alternative
`sender (anyOf 2)`	null	Alternative
`subject`	JSON	Optional
`subject (anyOf 1)`	string	Alternative
`subject (anyOf 2)`	null	Alternative

Update an agent — request body — body / json_definition / status: published, draft, auto generated, importing, import failed 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
`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
`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
`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
`label`	string	Required within parent	Author-facing identifier; must be unique per workflow.
`max_retries`	integer	Optional	Default: 0
`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
`title`	string	Optional	Default:
`url`	JSON	Optional
`url (anyOf 1)`	string	Alternative
`url (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 file download, download target: website, s3, azure, google drive, sftp

Field	Type	Presence	Description and constraints
`$`	object	Root
`aws_access_key_id`	JSON	Optional
`aws_access_key_id (anyOf 1)`	string	Alternative
`aws_access_key_id (anyOf 2)`	null	Alternative
`aws_secret_access_key`	JSON	Optional
`aws_secret_access_key (anyOf 1)`	string	Alternative
`aws_secret_access_key (anyOf 2)`	null	Alternative
`azure_blob_container_name`	JSON	Optional
`azure_blob_container_name (anyOf 1)`	string	Alternative
`azure_blob_container_name (anyOf 2)`	null	Alternative
`azure_storage_account_key`	JSON	Optional
`azure_storage_account_key (anyOf 1)`	string	Alternative
`azure_storage_account_key (anyOf 2)`	null	Alternative
`azure_storage_account_name`	JSON	Optional
`azure_storage_account_name (anyOf 1)`	string	Alternative
`azure_storage_account_name (anyOf 2)`	null	Alternative
`block_type`	string	Required within parent	Must equal: file_download Default: file_download
`continue_on_empty`	boolean	Optional	Default: false
`continue_on_failure`	boolean	Optional	Default: false
`disable_cache`	boolean	Optional	Default: false
`download_suffix`	JSON	Optional
`download_suffix (anyOf 1)`	string	Alternative
`download_suffix (anyOf 2)`	null	Alternative
`download_target`	string	Optional	One of: website, s3, azure, google_drive, sftp Default: website
`download_timeout`	JSON	Optional
`download_timeout (anyOf 1)`	number	Alternative
`download_timeout (anyOf 2)`	null	Alternative
`endpoint_url`	JSON	Optional
`endpoint_url (anyOf 1)`	string	Alternative
`endpoint_url (anyOf 2)`	null	Alternative
`engine`	JSON	Optional
`engine (anyOf 1)`	string	Alternative	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
`google_credential_id`	JSON	Optional
`google_credential_id (anyOf 1)`	string	Alternative
`google_credential_id (anyOf 2)`	null	Alternative
`google_drive_folder_id`	JSON	Optional
`google_drive_folder_id (anyOf 1)`	string	Alternative
`google_drive_folder_id (anyOf 2)`	null	Alternative
`ignore_workflow_system_prompt`	boolean	Optional	Default: false
`label`	string	Required within parent	Author-facing identifier; must be unique per workflow.
`max_retries`	integer	Optional	Default: 0
`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
`navigation_goal`	string	Required within parent
`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
`path`	JSON	Optional
`path (anyOf 1)`	string	Alternative
`path (anyOf 2)`	null	Alternative
`prompt`	JSON	Optional
`prompt (anyOf 1)`	string	Alternative
`prompt (anyOf 2)`	null	Alternative
`region_name`	JSON	Optional
`region_name (anyOf 1)`	string	Alternative
`region_name (anyOf 2)`	null	Alternative
`s3_bucket`	JSON	Optional
`s3_bucket (anyOf 1)`	string	Alternative
`s3_bucket (anyOf 2)`	null	Alternative
`sftp_host`	JSON	Optional
`sftp_host (anyOf 1)`	string	Alternative
`sftp_host (anyOf 2)`	null	Alternative
`sftp_host_key`	JSON	Optional
`sftp_host_key (anyOf 1)`	string	Alternative
`sftp_host_key (anyOf 2)`	null	Alternative
`sftp_password`	JSON	Optional
`sftp_password (anyOf 1)`	string	Alternative
`sftp_password (anyOf 2)`	null	Alternative
`sftp_port`	JSON	Optional
`sftp_port (anyOf 1)`	integer	Alternative
`sftp_port (anyOf 2)`	null	Alternative
`sftp_private_key`	JSON	Optional
`sftp_private_key (anyOf 1)`	string	Alternative
`sftp_private_key (anyOf 2)`	null	Alternative
`sftp_private_key_passphrase`	JSON	Optional
`sftp_private_key_passphrase (anyOf 1)`	string	Alternative
`sftp_private_key_passphrase (anyOf 2)`	null	Alternative
`sftp_remote_path`	JSON	Optional
`sftp_remote_path (anyOf 1)`	string	Alternative
`sftp_remote_path (anyOf 2)`	null	Alternative
`sftp_source_path`	JSON	Optional
`sftp_source_path (anyOf 1)`	string	Alternative
`sftp_source_path (anyOf 2)`	null	Alternative
`sftp_username`	JSON	Optional
`sftp_username (anyOf 1)`	string	Alternative
`sftp_username (anyOf 2)`	null	Alternative
`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

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`aws_access_key_id`	JSON	Optional
`aws_access_key_id (anyOf 1)`	string	Alternative
`aws_access_key_id (anyOf 2)`	null	Alternative
`aws_secret_access_key`	JSON	Optional
`aws_secret_access_key (anyOf 1)`	string	Alternative
`aws_secret_access_key (anyOf 2)`	null	Alternative
`azure_blob_container_name`	JSON	Optional
`azure_blob_container_name (anyOf 1)`	string	Alternative
`azure_blob_container_name (anyOf 2)`	null	Alternative
`azure_folder_path`	JSON	Optional
`azure_folder_path (anyOf 1)`	string	Alternative
`azure_folder_path (anyOf 2)`	null	Alternative
`azure_storage_account_key`	JSON	Optional
`azure_storage_account_key (anyOf 1)`	string	Alternative
`azure_storage_account_key (anyOf 2)`	null	Alternative
`azure_storage_account_name`	JSON	Optional
`azure_storage_account_name (anyOf 1)`	string	Alternative
`azure_storage_account_name (anyOf 2)`	null	Alternative
`block_type`	string	Required within parent	Must equal: file_upload Default: file_upload
`continue_on_failure`	boolean	Optional	Default: false
`endpoint_url`	JSON	Optional
`endpoint_url (anyOf 1)`	string	Alternative
`endpoint_url (anyOf 2)`	null	Alternative
`google_credential_id`	JSON	Optional
`google_credential_id (anyOf 1)`	string	Alternative
`google_credential_id (anyOf 2)`	null	Alternative
`google_drive_folder_id`	JSON	Optional
`google_drive_folder_id (anyOf 1)`	string	Alternative
`google_drive_folder_id (anyOf 2)`	null	Alternative
`ignore_workflow_system_prompt`	boolean	Optional	Default: false
`label`	string	Required within parent	Author-facing identifier; 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
`prompt`	JSON	Optional	Optional natural-language control over which downloaded files are uploaded; empty means upload all.
`prompt (anyOf 1)`	string	Alternative
`prompt (anyOf 2)`	null	Alternative
`region_name`	JSON	Optional
`region_name (anyOf 1)`	string	Alternative
`region_name (anyOf 2)`	null	Alternative
`s3_bucket`	JSON	Optional
`s3_bucket (anyOf 1)`	string	Alternative
`s3_bucket (anyOf 2)`	null	Alternative
`sftp_host`	JSON	Optional
`sftp_host (anyOf 1)`	string	Alternative
`sftp_host (anyOf 2)`	null	Alternative
`sftp_host_key`	JSON	Optional
`sftp_host_key (anyOf 1)`	string	Alternative
`sftp_host_key (anyOf 2)`	null	Alternative
`sftp_password`	JSON	Optional
`sftp_password (anyOf 1)`	string	Alternative
`sftp_password (anyOf 2)`	null	Alternative
`sftp_port`	JSON	Optional
`sftp_port (anyOf 1)`	integer	Alternative
`sftp_port (anyOf 2)`	null	Alternative
`sftp_private_key`	JSON	Optional
`sftp_private_key (anyOf 1)`	string	Alternative
`sftp_private_key (anyOf 2)`	null	Alternative
`sftp_private_key_passphrase`	JSON	Optional
`sftp_private_key_passphrase (anyOf 1)`	string	Alternative
`sftp_private_key_passphrase (anyOf 2)`	null	Alternative
`sftp_remote_path`	JSON	Optional
`sftp_remote_path (anyOf 1)`	string	Alternative
`sftp_remote_path (anyOf 2)`	null	Alternative
`sftp_username`	JSON	Optional
`sftp_username (anyOf 1)`	string	Alternative
`sftp_username (anyOf 2)`	null	Alternative
`storage_type`	string	Optional	One of: s3, azure, google_drive, sftp Default: s3

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: file_url_parser Default: file_url_parser
`continue_on_failure`	boolean	Optional	Default: false
`file_type`	string	Optional	One of: auto_detect, csv, excel, pdf, image, docx, zip Default: auto_detect
`file_url`	string	Required within parent
`force_ocr`	boolean	Optional	PDF only: ignore the PDF's embedded text layer and read the pages with vision OCR instead. Use it when a PDF's text layer is unreadable in a way Skyvern does not detect on its own. OCR reads at most the first 50 pages, so a longer PDF loses the rest; leave this off unless the text layer is unusable. Default: false
`ignore_workflow_system_prompt`	boolean	Optional	Default: false
`json_schema`	JSON	Optional
`json_schema (anyOf 1)`	object	Alternative	Additional keys: allowed
`json_schema (anyOf 2)`	null	Alternative
`label`	string	Required within parent	Author-facing identifier; 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
`worksheet`	JSON	Optional
`worksheet (anyOf 1)`	string	Alternative
`worksheet (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 for loop

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: for_loop Default: for_loop
`complete_if_empty`	boolean	Optional	Default: false
`continue_on_failure`	boolean	Optional	Default: false
`data_schema`	JSON	Optional
`data_schema (anyOf 1)`	object	Alternative	Additional keys: allowed
`data_schema (anyOf 2)`	string	Alternative
`data_schema (anyOf 3)`	null	Alternative
`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
`loop_over_parameter_key`	string	Optional	Default:
`loop_variable_reference`	JSON	Optional
`loop_variable_reference (anyOf 1)`	string	Alternative
`loop_variable_reference (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

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: google_sheets_read Default: google_sheets_read
`continue_on_failure`	boolean	Optional	Default: false
`credential_id`	JSON	Optional
`credential_id (anyOf 1)`	string	Alternative
`credential_id (anyOf 2)`	null	Alternative
`has_header_row`	boolean	Optional	Default: true
`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
`range`	JSON	Optional
`range (anyOf 1)`	string	Alternative
`range (anyOf 2)`	null	Alternative
`sheet_name`	JSON	Optional
`sheet_name (anyOf 1)`	string	Alternative
`sheet_name (anyOf 2)`	null	Alternative
`spreadsheet_url`	string	Required within parent

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: google_sheets_write Default: google_sheets_write
`column_mapping`	JSON	Optional
`column_mapping (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`column_mapping (anyOf 1).*`	string	Additional keys
`column_mapping (anyOf 2)`	null	Alternative
`continue_on_failure`	boolean	Optional	Default: false
`create_sheet_if_missing`	boolean	Optional	Default: false
`credential_id`	JSON	Optional
`credential_id (anyOf 1)`	string	Alternative
`credential_id (anyOf 2)`	null	Alternative
`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
`range`	JSON	Optional
`range (anyOf 1)`	string	Alternative
`range (anyOf 2)`	null	Alternative
`sheet_name`	JSON	Optional
`sheet_name (anyOf 1)`	string	Alternative
`sheet_name (anyOf 2)`	null	Alternative
`spreadsheet_url`	string	Required within parent
`values`	string	Optional	Default:
`write_mode`	string	Optional	Default: append One of: append, update

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: http_request Default: http_request
`body`	JSON	Optional
`body (anyOf 1)`	object	Alternative	Additional keys: allowed
`body (anyOf 2)`	null	Alternative
`continue_on_failure`	boolean	Optional	Default: false
`download_filename`	JSON	Optional
`download_filename (anyOf 1)`	string	Alternative
`download_filename (anyOf 2)`	null	Alternative
`files`	JSON	Optional
`files (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`files (anyOf 1).*`	string	Additional keys
`files (anyOf 2)`	null	Alternative
`follow_redirects`	boolean	Optional	Default: true
`headers`	JSON	Optional
`headers (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`headers (anyOf 1).*`	string	Additional keys
`headers (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.
`method`	string	Optional	Default: GET
`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
`save_response_as_file`	boolean	Optional	Default: false
`secret_response_paths`	JSON	Optional
`secret_response_paths (anyOf 1)`	array	Alternative
`secret_response_paths (anyOf 1)[]`	string	Each item
`secret_response_paths (anyOf 2)`	null	Alternative
`timeout`	integer	Optional	Default: 30
`url`	JSON	Optional
`url (anyOf 1)`	string	Alternative
`url (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 human interaction, body format: text, html

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: human_interaction Default: human_interaction
`body`	string	Optional	Default: Your interaction is required for a workflow run!
`body_format`	string	Optional	One of: text, html Default: text
`continue_on_failure`	boolean	Optional	Default: false
`ignore_workflow_system_prompt`	boolean	Optional	Default: false
`instructions`	string	Optional	Default: Please review and approve or reject to continue the workflow.
`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
`negative_descriptor`	string	Optional	Default: Reject
`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
`positive_descriptor`	string	Optional	Default: Approve
`recipients`	array	Required within parent
`recipients[]`	string	Each item
`sender`	string	Optional	Default: hello at skyvern.com
`subject`	string	Optional	Default: Human interaction required for workflow run
`timeout_seconds`	integer	Optional	Default: 7200

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: login Default: login
`complete_criterion`	JSON	Optional
`complete_criterion (anyOf 1)`	string	Alternative
`complete_criterion (anyOf 2)`	null	Alternative
`complete_verification`	boolean	Optional	Default: true
`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
`include_action_history_in_verification`	boolean	Optional	Default: false
`label`	string	Required within parent	Author-facing identifier; must be unique per workflow.
`max_retries`	integer	Optional	Default: 0
`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
`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 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
`skip_saved_profile`	boolean	Optional	Default: false
`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

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: navigation Default: navigation
`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
`disable_cache`	boolean	Optional	Default: false
`download_suffix`	JSON	Optional
`download_suffix (anyOf 1)`	string	Alternative
`download_suffix (anyOf 2)`	null	Alternative
`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
`include_action_history_in_verification`	boolean	Optional	Default: false
`label`	string	Required within parent	Author-facing identifier; must be unique per workflow.
`max_retries`	integer	Optional	Default: 0
`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
`navigation_goal`	string	Required within parent
`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
`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

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: pdf_fill Default: pdf_fill
`continue_on_failure`	boolean	Optional	Default: false
`file_url`	string	Required within parent
`ignore_workflow_system_prompt`	boolean	Optional	Default: false
`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
`payload`	JSON	Optional
`payload (anyOf 1)`	object	Alternative	Additional keys: allowed
`payload (anyOf 2)`	array	Alternative
`payload (anyOf 2)[]`	JSON	Each item
`payload (anyOf 3)`	string	Alternative
`payload (anyOf 4)`	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 pdf parser

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: pdf_parser Default: pdf_parser
`continue_on_failure`	boolean	Optional	Default: false
`file_url`	string	Required within parent
`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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Documented ahead of release; saves are unavailable until the Power BI catalog status is live.
`block_type`	string	Required within parent	Must equal: powerbi_query Default: powerbi_query
`connection_id`	string	Required within parent	Microsoft OAuth credential ID for this user. Minimum length: 1
`continue_on_failure`	boolean	Optional	Default: false
`dataset_id`	string	Required within parent	Minimum length: 1
`ignore_workflow_system_prompt`	boolean	Optional	Default: false
`label`	string	Required within parent	Author-facing identifier; must be unique per workflow.
`max_rows`	integer	Optional	Default: 1000 Maximum: 100000.0 Minimum: 1.0
`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
`query`	string	Required within parent	A single read-only DAX query. 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 print page, format: A4, Letter, Legal, Tabloid

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: print_page Default: print_page
`continue_on_failure`	boolean	Optional	Default: false
`custom_filename`	JSON	Optional
`custom_filename (anyOf 1)`	string	Alternative
`custom_filename (anyOf 2)`	null	Alternative
`format`	string	Optional	One of: A4, Letter, Legal, Tabloid Default: A4
`ignore_workflow_system_prompt`	boolean	Optional	Default: false
`include_timestamp`	boolean	Optional	Default: true
`label`	string	Required within parent	Author-facing identifier; must be unique per workflow.
`landscape`	boolean	Optional	Default: false
`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
`print_background`	boolean	Optional	Default: true

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`bcc`	array	Optional	Bcc recipients. Only with transport 'gmail'.
`bcc[]`	string	Each item
`block_type`	string	Required within parent	Must equal: send_email Default: send_email
`body`	string	Required within parent
`body_format`	string	Optional	One of: text, html Default: text
`cc`	array	Optional	Cc recipients. Only with transport 'gmail'.
`cc[]`	string	Each item
`continue_on_failure`	boolean	Optional	Default: false
`credential_id`	JSON	Optional	ID of a connected Google account that has send permission. Used only with transport 'gmail'.
`credential_id (anyOf 1)`	string	Alternative
`credential_id (anyOf 2)`	null	Alternative
`custom_smtp_host`	JSON	Optional
`custom_smtp_host (anyOf 1)`	string	Alternative
`custom_smtp_host (anyOf 2)`	null	Alternative
`custom_smtp_password`	JSON	Optional
`custom_smtp_password (anyOf 1)`	string	Alternative
`custom_smtp_password (anyOf 2)`	null	Alternative
`custom_smtp_port`	JSON	Optional
`custom_smtp_port (anyOf 1)`	integer	Alternative	Maximum: 65535.0 Minimum: 1.0
`custom_smtp_port (anyOf 2)`	null	Alternative
`custom_smtp_username`	JSON	Optional
`custom_smtp_username (anyOf 1)`	string	Alternative
`custom_smtp_username (anyOf 2)`	null	Alternative
`file_attachments`	JSON	Optional
`file_attachments (anyOf 1)`	array	Alternative
`file_attachments (anyOf 1)[]`	string	Each item
`file_attachments (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
`recipients`	array	Required within parent
`recipients[]`	string	Each item
`sender`	string	Optional	From address. Required unless transport is 'gmail'. Default:
`smtp_host_secret_parameter_key`	JSON	Optional
`smtp_host_secret_parameter_key (anyOf 1)`	string	Alternative
`smtp_host_secret_parameter_key (anyOf 2)`	null	Alternative
`smtp_password_secret_parameter_key`	JSON	Optional
`smtp_password_secret_parameter_key (anyOf 1)`	string	Alternative
`smtp_password_secret_parameter_key (anyOf 2)`	null	Alternative
`smtp_port_secret_parameter_key`	JSON	Optional
`smtp_port_secret_parameter_key (anyOf 1)`	string	Alternative
`smtp_port_secret_parameter_key (anyOf 2)`	null	Alternative
`smtp_username_secret_parameter_key`	JSON	Optional
`smtp_username_secret_parameter_key (anyOf 1)`	string	Alternative
`smtp_username_secret_parameter_key (anyOf 2)`	null	Alternative
`subject`	string	Required within parent
`transport`	JSON	Optional	How the email is sent. Omit for SMTP. 'gmail' sends from the connected Google account named by credential_id; sender and the SMTP settings are then unused.
`transport (anyOf 1)`	string	Alternative	One of: smtp, gmail
`transport (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 split pdf

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: split_pdf Default: split_pdf
`continue_on_failure`	boolean	Optional	Default: false
`file_url`	string	Required within parent
`ignore_workflow_system_prompt`	boolean	Optional	Default: false
`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 task

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: task Default: task
`complete_criterion`	JSON	Optional
`complete_criterion (anyOf 1)`	string	Alternative
`complete_criterion (anyOf 2)`	null	Alternative
`complete_on_download`	boolean	Optional	Default: false
`complete_verification`	boolean	Optional	Default: true
`continue_on_failure`	boolean	Optional	Default: false
`data_extraction_goal`	JSON	Optional
`data_extraction_goal (anyOf 1)`	string	Alternative
`data_extraction_goal (anyOf 2)`	null	Alternative
`data_schema`	JSON	Optional
`data_schema (anyOf 1)`	object	Alternative	Additional keys: allowed
`data_schema (anyOf 2)`	array	Alternative
`data_schema (anyOf 2)[]`	JSON	Each item
`data_schema (anyOf 3)`	string	Alternative
`data_schema (anyOf 4)`	null	Alternative
`disable_cache`	boolean	Optional	Default: false
`download_suffix`	JSON	Optional
`download_suffix (anyOf 1)`	string	Alternative
`download_suffix (anyOf 2)`	null	Alternative
`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
`include_action_history_in_verification`	boolean	Optional	Default: false
`label`	string	Required within parent	Author-facing identifier; must be unique per workflow.
`max_retries`	integer	Optional	Default: 0
`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
`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 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
`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

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

Field	Type	Presence	Description and constraints
`$`	object	Root
`block_type`	string	Required within parent	Must equal: task_v2 Default: task_v2
`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; must be unique per workflow.
`max_iterations`	integer	Optional	Default: 50
`max_steps`	integer	Optional	Default: 25
`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
`prompt`	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
`url`	JSON	Optional
`url (anyOf 1)`	string	Alternative
`url (anyOf 2)`	null	Alternative

Report an issue with this page