Skyvern: Runs schemas

17 Skyvern schemas with complete fields and constraints.

Bulk cancel runs — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`run_ids`	array	Required within parent	List of run IDs to cancel Maximum items: 100
`run_ids[]`	string	Each item

Bulk cancel runs — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`cancelled`	array	Required within parent	Run IDs that were successfully cancelled
`cancelled[]`	string	Each item
`failed`	array	Required within parent	Run IDs that could not be cancelled
`failed[]`	string	Each item

Get all runs — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root
`ai_fallback`	JSON	Optional
`ai_fallback (anyOf 1)`	boolean	Alternative
`ai_fallback (anyOf 2)`	null	Alternative
`attempt`	JSON	Optional
`attempt (anyOf 1)`	integer	Alternative	One-based number of the current workflow run attempt Default: 1
`attempt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`attempts`	array	Optional	Attempts recorded for this workflow run
`attempts[]`	Model	Each item	Expand Login Task — response body — attempts item
`browser_address`	JSON	Optional
`browser_address (anyOf 1)`	string	Alternative
`browser_address (anyOf 2)`	null	Alternative
`browser_profile_id`	JSON	Optional
`browser_profile_id (anyOf 1)`	string	Alternative
`browser_profile_id (anyOf 2)`	null	Alternative
`browser_seed_source`	JSON	Optional
`browser_seed_source (anyOf 1)`	Model	Alternative	Expand Login Task — response body — browser seed source string
`browser_seed_source (anyOf 2)`	null	Alternative
`browser_session_id`	JSON	Optional
`browser_session_id (anyOf 1)`	string	Alternative
`browser_session_id (anyOf 2)`	null	Alternative
`browser_settings`	JSON	Optional	Browser settings copied from the workflow version when the run was created
`browser_settings (anyOf 1)`	Model	Alternative	Expand Get a session — response body — browser settings timezone id
`browser_settings (anyOf 2)`	null	Alternative
`browser_settings_receipt`	JSON	Optional
`browser_settings_receipt (anyOf 1)`	Model	Alternative	Expand Login Task — response body — browser_settings_receipt / source: workflow version, session request, existing session, status: verified, mismatch, unapplied, unknown
`browser_settings_receipt (anyOf 2)`	null	Alternative
`browser_sink_profile_id`	JSON	Optional
`browser_sink_profile_id (anyOf 1)`	string	Alternative
`browser_sink_profile_id (anyOf 2)`	null	Alternative
`browser_type`	JSON	Optional
`browser_type (anyOf 1)`	string	Alternative
`browser_type (anyOf 2)`	null	Alternative
`cached_credits_used`	JSON	Optional
`cached_credits_used (anyOf 1)`	integer	Alternative	Default: 0
`cached_credits_used (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`cdp_connect_headers`	JSON	Optional
`cdp_connect_headers (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`cdp_connect_headers (anyOf 1).*`	string	Additional keys
`cdp_connect_headers (anyOf 2)`	null	Alternative
`code_gen`	JSON	Optional
`code_gen (anyOf 1)`	boolean	Alternative
`code_gen (anyOf 2)`	null	Alternative
`copilot_session_id`	JSON	Optional
`copilot_session_id (anyOf 1)`	string	Alternative
`copilot_session_id (anyOf 2)`	null	Alternative
`created_at`	string	Required within parent	Format: date-time
`created_by`	JSON	Optional	ID of the user who started the run
`created_by (anyOf 1)`	string	Alternative
`created_by (anyOf 2)`	null	Alternative
`credits_used`	JSON	Optional
`credits_used (anyOf 1)`	integer	Alternative	Default: 0
`credits_used (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`debug_session_id`	JSON	Optional
`debug_session_id (anyOf 1)`	string	Alternative
`debug_session_id (anyOf 2)`	null	Alternative
`depends_on_workflow_run_id`	JSON	Optional
`depends_on_workflow_run_id (anyOf 1)`	string	Alternative
`depends_on_workflow_run_id (anyOf 2)`	null	Alternative
`extra_http_headers`	JSON	Optional
`extra_http_headers (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`extra_http_headers (anyOf 1).*`	string	Additional keys
`extra_http_headers (anyOf 2)`	null	Alternative
`failure_category`	JSON	Optional
`failure_category (anyOf 1)`	array	Alternative
`failure_category (anyOf 1)[]`	object	Each item	Additional keys: allowed
`failure_category (anyOf 2)`	null	Alternative
`failure_reason`	JSON	Optional
`failure_reason (anyOf 1)`	string	Alternative
`failure_reason (anyOf 2)`	null	Alternative
`fallback_attempt`	JSON	Optional
`fallback_attempt (anyOf 1)`	JSON	Alternative
`fallback_attempt (anyOf 1) (anyOf 1)`	integer	Alternative
`fallback_attempt (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`fallback_attempt (anyOf 2)`	null	Alternative
`finished_at`	JSON	Optional
`finished_at (anyOf 1)`	string	Alternative	Format: date-time
`finished_at (anyOf 2)`	null	Alternative
`ignore_inherited_workflow_system_prompt`	boolean	Optional	Default: false
`job_id`	JSON	Optional
`job_id (anyOf 1)`	string	Alternative
`job_id (anyOf 2)`	null	Alternative
`max_elapsed_time_minutes`	JSON	Optional
`max_elapsed_time_minutes (anyOf 1)`	JSON	Alternative
`max_elapsed_time_minutes (anyOf 1) (anyOf 1)`	integer	Alternative
`max_elapsed_time_minutes (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`max_elapsed_time_minutes (anyOf 2)`	null	Alternative
`max_screenshot_scrolls`	JSON	Optional
`max_screenshot_scrolls (anyOf 1)`	JSON	Alternative
`max_screenshot_scrolls (anyOf 1) (anyOf 1)`	integer	Alternative
`max_screenshot_scrolls (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`max_screenshot_scrolls (anyOf 2)`	null	Alternative
`modified_at`	string	Required within parent	Format: date-time
`next_attempt_at`	JSON	Optional	Timestamp when the next workflow run attempt is scheduled
`next_attempt_at (anyOf 1)`	string	Alternative	Format: date-time
`next_attempt_at (anyOf 2)`	null	Alternative
`organization_id`	string	Required within parent
`parent_workflow_run_id`	JSON	Optional
`parent_workflow_run_id (anyOf 1)`	string	Alternative
`parent_workflow_run_id (anyOf 2)`	null	Alternative
`proxy_location`	JSON	Optional
`proxy_location (anyOf 1)`	Model	Alternative	Expand Update an agent — response body — proxy location string
`proxy_location (anyOf 2)`	Model	Alternative	Expand Update an agent — response body — proxy location city, country, is ISP, subdivision
`proxy_location (anyOf 3)`	object	Alternative	Additional keys: allowed
`proxy_location (anyOf 4)`	null	Alternative
`queued_at`	JSON	Optional
`queued_at (anyOf 1)`	string	Alternative	Format: date-time
`queued_at (anyOf 2)`	null	Alternative
`retried_from_workflow_run_id`	JSON	Optional
`retried_from_workflow_run_id (anyOf 1)`	string	Alternative
`retried_from_workflow_run_id (anyOf 2)`	null	Alternative
`retry_pending`	boolean	Optional	Whether another attempt is scheduled for this workflow run Default: false
`reuse_browser_session`	JSON	Optional
`reuse_browser_session (anyOf 1)`	boolean	Alternative
`reuse_browser_session (anyOf 2)`	null	Alternative
`run_with`	JSON	Optional
`run_with (anyOf 1)`	string	Alternative
`run_with (anyOf 2)`	null	Alternative
`script_run`	JSON	Optional
`script_run (anyOf 1)`	Model	Alternative	Expand Login Task — response body — script run ai fallback triggered, script id, script revision id
`script_run (anyOf 2)`	null	Alternative
`sequential_credential_id`	JSON	Optional
`sequential_credential_id (anyOf 1)`	string	Alternative
`sequential_credential_id (anyOf 2)`	null	Alternative
`sequential_key`	JSON	Optional
`sequential_key (anyOf 1)`	string	Alternative
`sequential_key (anyOf 2)`	null	Alternative
`start_fresh_browser`	JSON	Optional
`start_fresh_browser (anyOf 1)`	boolean	Alternative
`start_fresh_browser (anyOf 2)`	null	Alternative
`started_at`	JSON	Optional
`started_at (anyOf 1)`	string	Alternative	Format: date-time
`started_at (anyOf 2)`	null	Alternative
`status`	string	Required within parent	Known values: created, queued, running, failed, terminated, canceled, timed_out, completed, paused
`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
`trigger_type`	JSON	Optional
`trigger_type (anyOf 1)`	Model	Alternative	Expand List runs — response body — item trigger type How a workflow run was initiated
`trigger_type (anyOf 2)`	null	Alternative
`webhook_callback_url`	JSON	Optional
`webhook_callback_url (anyOf 1)`	string	Alternative
`webhook_callback_url (anyOf 2)`	null	Alternative
`webhook_failure_reason`	JSON	Optional
`webhook_failure_reason (anyOf 1)`	string	Alternative
`webhook_failure_reason (anyOf 2)`	null	Alternative
`workflow_id`	string	Required within parent
`workflow_permanent_id`	string	Required within parent
`workflow_run_id`	string	Required within parent
`workflow_schedule_id`	JSON	Optional
`workflow_schedule_id (anyOf 1)`	string	Alternative
`workflow_schedule_id (anyOf 2)`	null	Alternative
`workflow_title`	JSON	Optional
`workflow_title (anyOf 1)`	string	Alternative
`workflow_title (anyOf 2)`	null	Alternative

Get run timeline — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root
`attempt`	JSON	Optional
`attempt (anyOf 1)`	integer	Alternative	Default: 1
`attempt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`block`	JSON	Optional
`block (anyOf 1)`	Model	Alternative	Expand Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id
`block (anyOf 2)`	null	Alternative
`children`	array	Optional	Default: []
`children[]`	Model	Each item	Expand Get run timeline — response body — item
`created_at`	string	Required within parent	Format: date-time
`modified_at`	string	Required within parent	Format: date-time
`thought`	JSON	Optional
`thought (anyOf 1)`	Model	Alternative	Expand Get run timeline — response body — item thought answer, cached token count, created at, input token count, last llm model, modified at, observation, organization id, output, output token count, reasoning token count, task id, thought, thought cost, thought id, thought scenario, thought type, user input, workflow id, workflow permanent id, workflow run block id, workflow run id
`thought (anyOf 2)`	null	Alternative
`type`	string	Required within parent	Known values: thought, block

Referenced models: Get run timeline — response body — item thought answer, cached token count, created at, input token count, last llm model, modified at, observation, organization id, output, output token count, reasoning token count, task id, thought, thought cost, thought id, thought scenario, thought type, user input, workflow id, workflow permanent id, workflow run block id, workflow run id, Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id, Get run timeline — response body — item

Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id

Field	Type	Presence	Description and constraints
`$`	object	Root
`actions`	array	Optional	Default: []
`actions[]`	Model	Each item	Expand Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id actions item
`attachments`	JSON	Optional
`attachments (anyOf 1)`	array	Alternative
`attachments (anyOf 1)[]`	string	Each item
`attachments (anyOf 2)`	null	Alternative
`attempt_number`	JSON	Optional
`attempt_number (anyOf 1)`	JSON	Alternative
`attempt_number (anyOf 1) (anyOf 1)`	integer	Alternative
`attempt_number (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`attempt_number (anyOf 2)`	null	Alternative
`block_type`	Model	Required within parent	Expand Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id block type
`block_workflow_run_id`	JSON	Optional
`block_workflow_run_id (anyOf 1)`	string	Alternative
`block_workflow_run_id (anyOf 2)`	null	Alternative
`body`	JSON	Optional
`body (anyOf 1)`	string	Alternative
`body (anyOf 2)`	null	Alternative
`complete_criterion`	JSON	Optional
`complete_criterion (anyOf 1)`	string	Alternative
`complete_criterion (anyOf 2)`	null	Alternative
`continue_on_failure`	boolean	Optional	Default: false
`created_at`	string	Required within parent	Format: date-time
`current_index`	JSON	Optional
`current_index (anyOf 1)`	JSON	Alternative
`current_index (anyOf 1) (anyOf 1)`	integer	Alternative
`current_index (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`current_index (anyOf 2)`	null	Alternative
`current_value`	JSON	Optional
`current_value (anyOf 1)`	string	Alternative
`current_value (anyOf 2)`	null	Alternative
`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
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`downloaded_file_count`	JSON	Optional
`downloaded_file_count (anyOf 1)`	JSON	Alternative
`downloaded_file_count (anyOf 1) (anyOf 1)`	integer	Alternative
`downloaded_file_count (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`downloaded_file_count (anyOf 2)`	null	Alternative
`duration`	JSON	Optional
`duration (anyOf 1)`	JSON	Alternative
`duration (anyOf 1) (anyOf 1)`	number	Alternative
`duration (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`duration (anyOf 2)`	null	Alternative
`engine`	JSON	Optional
`engine (anyOf 1)`	string	Alternative	Known values: skyvern-1.0, skyvern-2.0, skyvern-3.0, openai-cua, anthropic-cua, ui-tars, yutori-navigator
`engine (anyOf 2)`	null	Alternative
`error_codes`	array	Optional	Default: []
`error_codes[]`	string	Each item
`executed_branch_expression`	JSON	Optional
`executed_branch_expression (anyOf 1)`	string	Alternative
`executed_branch_expression (anyOf 2)`	null	Alternative
`executed_branch_id`	JSON	Optional
`executed_branch_id (anyOf 1)`	string	Alternative
`executed_branch_id (anyOf 2)`	null	Alternative
`executed_branch_next_block`	JSON	Optional
`executed_branch_next_block (anyOf 1)`	string	Alternative
`executed_branch_next_block (anyOf 2)`	null	Alternative
`executed_branch_result`	JSON	Optional
`executed_branch_result (anyOf 1)`	boolean	Alternative
`executed_branch_result (anyOf 2)`	null	Alternative
`failure_reason`	JSON	Optional
`failure_reason (anyOf 1)`	string	Alternative
`failure_reason (anyOf 2)`	null	Alternative
`final_url`	JSON	Optional
`final_url (anyOf 1)`	string	Alternative
`final_url (anyOf 2)`	null	Alternative
`finish_reason`	JSON	Optional
`finish_reason (anyOf 1)`	string	Alternative
`finish_reason (anyOf 2)`	null	Alternative
`include_action_history_in_verification`	JSON	Optional	Default: false
`include_action_history_in_verification (anyOf 1)`	boolean	Alternative
`include_action_history_in_verification (anyOf 2)`	null	Alternative
`include_extracted_text`	boolean	Optional	Default: true
`instructions`	JSON	Optional
`instructions (anyOf 1)`	string	Alternative
`instructions (anyOf 2)`	null	Alternative
`label`	JSON	Optional
`label (anyOf 1)`	string	Alternative
`label (anyOf 2)`	null	Alternative
`loop_values`	JSON	Optional
`loop_values (anyOf 1)`	array	Alternative
`loop_values (anyOf 1)[]`	JSON	Each item
`loop_values (anyOf 2)`	null	Alternative
`modified_at`	string	Required within parent	Format: date-time
`navigation_goal`	JSON	Optional
`navigation_goal (anyOf 1)`	string	Alternative
`navigation_goal (anyOf 2)`	null	Alternative
`navigation_payload`	JSON	Optional
`navigation_payload (anyOf 1)`	object	Alternative	Additional keys: allowed
`navigation_payload (anyOf 2)`	array	Alternative
`navigation_payload (anyOf 2)[]`	JSON	Each item
`navigation_payload (anyOf 3)`	string	Alternative
`navigation_payload (anyOf 4)`	null	Alternative
`negative_descriptor`	JSON	Optional
`negative_descriptor (anyOf 1)`	string	Alternative
`negative_descriptor (anyOf 2)`	null	Alternative
`organization_id`	string	Required within parent
`output`	JSON	Optional
`output (anyOf 1)`	object	Alternative	Additional keys: allowed
`output (anyOf 2)`	array	Alternative
`output (anyOf 2)[]`	JSON	Each item
`output (anyOf 3)`	string	Alternative
`output (anyOf 4)`	null	Alternative
`parent_workflow_run_block_id`	JSON	Optional
`parent_workflow_run_block_id (anyOf 1)`	string	Alternative
`parent_workflow_run_block_id (anyOf 2)`	null	Alternative
`positive_descriptor`	JSON	Optional
`positive_descriptor (anyOf 1)`	string	Alternative
`positive_descriptor (anyOf 2)`	null	Alternative
`prompt`	JSON	Optional
`prompt (anyOf 1)`	string	Alternative
`prompt (anyOf 2)`	null	Alternative
`recipients`	JSON	Optional
`recipients (anyOf 1)`	array	Alternative
`recipients (anyOf 1)[]`	string	Each item
`recipients (anyOf 2)`	null	Alternative
`script_run`	JSON	Optional
`script_run (anyOf 1)`	Model	Alternative	Expand Login Task — response body — script run ai fallback triggered, script id, script revision id
`script_run (anyOf 2)`	null	Alternative
`status`	JSON	Optional
`status (anyOf 1)`	string	Alternative
`status (anyOf 2)`	null	Alternative
`subject`	JSON	Optional
`subject (anyOf 1)`	string	Alternative
`subject (anyOf 2)`	null	Alternative
`task_id`	JSON	Optional
`task_id (anyOf 1)`	string	Alternative
`task_id (anyOf 2)`	null	Alternative
`terminate_criterion`	JSON	Optional
`terminate_criterion (anyOf 1)`	string	Alternative
`terminate_criterion (anyOf 2)`	null	Alternative
`url`	JSON	Optional
`url (anyOf 1)`	string	Alternative
`url (anyOf 2)`	null	Alternative
`workflow_run_block_id`	string	Required within parent
`workflow_run_id`	string	Required within parent

Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id actions item

Field	Type	Presence	Description and constraints
`$`	object	Root
`action_id`	JSON	Optional
`action_id (anyOf 1)`	string	Alternative
`action_id (anyOf 2)`	null	Alternative
`action_order`	JSON	Optional
`action_order (anyOf 1)`	JSON	Alternative
`action_order (anyOf 1) (anyOf 1)`	integer	Alternative
`action_order (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`action_order (anyOf 2)`	null	Alternative
`action_type`	string	Required within parent	Known values: click, input_text, paste_text, upload_file, download_file, select_option, checkbox, wait, hover, null_action, solve_captcha, terminate, complete, reload_page, close_page, new_tab, switch_tab, extract, verification_code, goto_url, go_back, go_forward, scroll, keypress, move, drag, left_mouse, execute_js
`click_context`	JSON	Optional
`click_context (anyOf 1)`	Model	Alternative	Expand Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id actions item click context desired state, single option click, thought
`click_context (anyOf 2)`	null	Alternative
`confidence_float`	JSON	Optional
`confidence_float (anyOf 1)`	JSON	Alternative
`confidence_float (anyOf 1) (anyOf 1)`	number	Alternative
`confidence_float (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`confidence_float (anyOf 2)`	null	Alternative
`created_at`	JSON	Optional
`created_at (anyOf 1)`	string	Alternative	Format: date-time
`created_at (anyOf 2)`	null	Alternative
`created_by`	JSON	Optional
`created_by (anyOf 1)`	string	Alternative
`created_by (anyOf 2)`	null	Alternative
`data_extraction_goal`	JSON	Optional
`data_extraction_goal (anyOf 1)`	string	Alternative
`data_extraction_goal (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`download`	JSON	Optional
`download (anyOf 1)`	boolean	Alternative
`download (anyOf 2)`	null	Alternative
`download_triggered`	JSON	Optional
`download_triggered (anyOf 1)`	boolean	Alternative
`download_triggered (anyOf 2)`	null	Alternative
`download_url`	JSON	Optional	Origin URL recorded by a download action.
`download_url (anyOf 1)`	string	Alternative
`download_url (anyOf 2)`	null	Alternative
`downloaded_files`	JSON	Optional
`downloaded_files (anyOf 1)`	array	Alternative
`downloaded_files (anyOf 1)[]`	string	Each item
`downloaded_files (anyOf 2)`	null	Alternative
`element_id`	JSON	Optional
`element_id (anyOf 1)`	string	Alternative
`element_id (anyOf 2)`	null	Alternative
`errors`	JSON	Optional
`errors (anyOf 1)`	array	Alternative
`errors (anyOf 1)[]`	Model	Each item	Expand Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id actions item errors array item
`errors (anyOf 2)`	null	Alternative
`file_name`	JSON	Optional
`file_name (anyOf 1)`	string	Alternative
`file_name (anyOf 2)`	null	Alternative
`file_url`	JSON	Optional
`file_url (anyOf 1)`	string	Alternative
`file_url (anyOf 2)`	null	Alternative
`finished_at`	JSON	Optional
`finished_at (anyOf 1)`	string	Alternative	Format: date-time
`finished_at (anyOf 2)`	null	Alternative
`has_mini_agent`	JSON	Optional
`has_mini_agent (anyOf 1)`	boolean	Alternative
`has_mini_agent (anyOf 2)`	null	Alternative
`input_or_select_context`	JSON	Optional
`input_or_select_context (anyOf 1)`	Model	Alternative	Expand Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id actions item input or select context date format, field, intention, is date related, is location input, is required, is search bar, is text captcha
`input_or_select_context (anyOf 2)`	null	Alternative
`intention`	JSON	Optional
`intention (anyOf 1)`	string	Alternative
`intention (anyOf 2)`	null	Alternative
`is_checked`	JSON	Optional
`is_checked (anyOf 1)`	boolean	Alternative
`is_checked (anyOf 2)`	null	Alternative
`is_upload_file_tag`	JSON	Optional
`is_upload_file_tag (anyOf 1)`	boolean	Alternative
`is_upload_file_tag (anyOf 2)`	null	Alternative
`modified_at`	JSON	Optional
`modified_at (anyOf 1)`	string	Alternative	Format: date-time
`modified_at (anyOf 2)`	null	Alternative
`option`	JSON	Optional
`option (anyOf 1)`	Model	Alternative	Expand Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id actions item option index, label, value
`option (anyOf 2)`	null	Alternative
`organization_id`	JSON	Optional
`organization_id (anyOf 1)`	string	Alternative
`organization_id (anyOf 2)`	null	Alternative
`output`	JSON	Optional
`output (anyOf 1)`	object	Alternative	Additional keys: allowed
`output (anyOf 2)`	array	Alternative
`output (anyOf 2)[]`	JSON	Each item
`output (anyOf 3)`	string	Alternative
`output (anyOf 4)`	null	Alternative
`reasoning`	JSON	Optional
`reasoning (anyOf 1)`	string	Alternative
`reasoning (anyOf 2)`	null	Alternative
`response`	JSON	Optional
`response (anyOf 1)`	string	Alternative
`response (anyOf 2)`	null	Alternative
`screenshot_artifact_id`	JSON	Optional
`screenshot_artifact_id (anyOf 1)`	string	Alternative
`screenshot_artifact_id (anyOf 2)`	null	Alternative
`skip_auto_complete_tab`	boolean	Optional	Default: false
`skyvern_element_data`	JSON	Optional
`skyvern_element_data (anyOf 1)`	object	Alternative	Additional keys: allowed
`skyvern_element_data (anyOf 2)`	null	Alternative
`skyvern_element_hash`	JSON	Optional
`skyvern_element_hash (anyOf 1)`	string	Alternative
`skyvern_element_hash (anyOf 2)`	null	Alternative
`source_action_id`	JSON	Optional
`source_action_id (anyOf 1)`	string	Alternative
`source_action_id (anyOf 2)`	null	Alternative
`started_at`	JSON	Optional
`started_at (anyOf 1)`	string	Alternative	Format: date-time
`started_at (anyOf 2)`	null	Alternative
`status`	string	Optional	Known values: pending, skipped, failed, completed Default: pending
`step_id`	JSON	Optional
`step_id (anyOf 1)`	string	Alternative
`step_id (anyOf 2)`	null	Alternative
`step_order`	JSON	Optional
`step_order (anyOf 1)`	JSON	Alternative
`step_order (anyOf 1) (anyOf 1)`	integer	Alternative
`step_order (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`step_order (anyOf 2)`	null	Alternative
`task_id`	JSON	Optional
`task_id (anyOf 1)`	string	Alternative
`task_id (anyOf 2)`	null	Alternative
`terminal_user_errors`	boolean	Optional	Default: false
`text`	JSON	Optional
`text (anyOf 1)`	string	Alternative
`text (anyOf 2)`	null	Alternative
`tool_call_id`	JSON	Optional
`tool_call_id (anyOf 1)`	string	Alternative
`tool_call_id (anyOf 2)`	null	Alternative
`totp_timing_info`	JSON	Optional
`totp_timing_info (anyOf 1)`	object	Alternative	Additional keys: allowed
`totp_timing_info (anyOf 2)`	null	Alternative
`verified`	boolean	Optional	Default: false
`workflow_run_id`	JSON	Optional
`workflow_run_id (anyOf 1)`	string	Alternative
`workflow_run_id (anyOf 2)`	null	Alternative
`xpath`	JSON	Optional
`xpath (anyOf 1)`	string	Alternative
`xpath (anyOf 2)`	null	Alternative

Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id actions item click context desired state, single option click, thought

Field	Type	Presence
`$`	object	Root
`desired_state`	JSON	Optional
`desired_state (anyOf 1)`	boolean	Alternative
`desired_state (anyOf 2)`	null	Alternative
`single_option_click`	JSON	Optional
`single_option_click (anyOf 1)`	boolean	Alternative
`single_option_click (anyOf 2)`	null	Alternative
`thought`	JSON	Optional
`thought (anyOf 1)`	string	Alternative
`thought (anyOf 2)`	null	Alternative

Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id actions item errors array item

Field	Type	Presence	Description and constraints
`$`	object	Root
`confidence_float`	JSON	Required within parent
`confidence_float (anyOf 1)`	number	Alternative	Maximum: 1.0 Minimum: 0.0
`confidence_float (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`error_code`	string	Required within parent
`error_type`	string	Optional	Must equal: USER_DEFINED_ERROR Default: USER_DEFINED_ERROR
`reasoning`	string	Required within parent

Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id actions item input or select context date format, field, intention, is date related, is location input, is required, is search bar, is text captcha

Field	Type	Presence
`$`	object	Root
`date_format`	JSON	Optional
`date_format (anyOf 1)`	string	Alternative
`date_format (anyOf 2)`	null	Alternative
`field`	JSON	Optional
`field (anyOf 1)`	string	Alternative
`field (anyOf 2)`	null	Alternative
`intention`	JSON	Optional
`intention (anyOf 1)`	string	Alternative
`intention (anyOf 2)`	null	Alternative
`is_date_related`	JSON	Optional
`is_date_related (anyOf 1)`	boolean	Alternative
`is_date_related (anyOf 2)`	null	Alternative
`is_location_input`	JSON	Optional
`is_location_input (anyOf 1)`	boolean	Alternative
`is_location_input (anyOf 2)`	null	Alternative
`is_required`	JSON	Optional
`is_required (anyOf 1)`	boolean	Alternative
`is_required (anyOf 2)`	null	Alternative
`is_search_bar`	JSON	Optional
`is_search_bar (anyOf 1)`	boolean	Alternative
`is_search_bar (anyOf 2)`	null	Alternative
`is_text_captcha`	JSON	Optional
`is_text_captcha (anyOf 1)`	boolean	Alternative
`is_text_captcha (anyOf 2)`	null	Alternative

Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id actions item option index, label, value

Field	Type	Presence	Description and constraints
`$`	object	Root
`index`	JSON	Optional
`index (anyOf 1)`	JSON	Alternative
`index (anyOf 1) (anyOf 1)`	integer	Alternative
`index (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`index (anyOf 2)`	null	Alternative
`label`	JSON	Optional
`label (anyOf 1)`	string	Alternative
`label (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative
`value (anyOf 2)`	null	Alternative

Get run timeline — response body — item block actions, attachments, attempt number, block type, block workflow run id, body, complete criterion, continue on failure, created at, current index, current value, data extraction goal, data schema, description, downloaded file count, duration, engine, error codes, executed branch expression, executed branch id, executed branch next block, executed branch result, failure reason, final url, finish reason, include action history in verification, include extracted text, instructions, label, loop values, modified at, navigation goal, navigation payload, negative descriptor, organization id, output, parent workflow run block id, positive descriptor, prompt, recipients, script run, status, subject, task id, terminate criterion, url, workflow run block id, workflow run id block type

Field	Type	Presence	Description and constraints
`$`	string	Root	Known values: task, task_v2, for_loop, while_loop, conditional, code, text_prompt, download_to_s3, upload_to_s3, file_upload, send_email, file_url_parser, validation, action, navigation, extraction, login, wait, file_download, goto_url, pdf_parser, http_request, web_search, human_interaction, print_page, workflow_trigger, google_sheets_read, google_sheets_write, powerbi_query, pdf_fill, split_pdf, email_inbox, data_export, terminate, agent_step

Get run timeline — response body — item thought answer, cached token count, created at, input token count, last llm model, modified at, observation, organization id, output, output token count, reasoning token count, task id, thought, thought cost, thought id, thought scenario, thought type, user input, workflow id, workflow permanent id, workflow run block id, workflow run id

Field	Type	Presence	Description and constraints
`$`	object	Root
`answer`	JSON	Optional
`answer (anyOf 1)`	string	Alternative
`answer (anyOf 2)`	null	Alternative
`cached_token_count`	JSON	Optional
`cached_token_count (anyOf 1)`	JSON	Alternative
`cached_token_count (anyOf 1) (anyOf 1)`	integer	Alternative
`cached_token_count (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`cached_token_count (anyOf 2)`	null	Alternative
`created_at`	string	Required within parent	Format: date-time
`input_token_count`	JSON	Optional
`input_token_count (anyOf 1)`	JSON	Alternative
`input_token_count (anyOf 1) (anyOf 1)`	integer	Alternative
`input_token_count (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`input_token_count (anyOf 2)`	null	Alternative
`last_llm_model`	JSON	Optional
`last_llm_model (anyOf 1)`	string	Alternative
`last_llm_model (anyOf 2)`	null	Alternative
`modified_at`	string	Required within parent	Format: date-time
`observation`	JSON	Optional
`observation (anyOf 1)`	string	Alternative
`observation (anyOf 2)`	null	Alternative
`organization_id`	string	Required within parent
`output`	JSON	Optional
`output (anyOf 1)`	object	Alternative	Additional keys: allowed
`output (anyOf 2)`	null	Alternative
`output_token_count`	JSON	Optional
`output_token_count (anyOf 1)`	JSON	Alternative
`output_token_count (anyOf 1) (anyOf 1)`	integer	Alternative
`output_token_count (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`output_token_count (anyOf 2)`	null	Alternative
`reasoning_token_count`	JSON	Optional
`reasoning_token_count (anyOf 1)`	JSON	Alternative
`reasoning_token_count (anyOf 1) (anyOf 1)`	integer	Alternative
`reasoning_token_count (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`reasoning_token_count (anyOf 2)`	null	Alternative
`task_id`	string	Required within parent
`thought`	JSON	Optional
`thought (anyOf 1)`	string	Alternative
`thought (anyOf 2)`	null	Alternative
`thought_cost`	JSON	Optional
`thought_cost (anyOf 1)`	JSON	Alternative
`thought_cost (anyOf 1) (anyOf 1)`	number	Alternative
`thought_cost (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`thought_cost (anyOf 2)`	null	Alternative
`thought_id`	string	Required within parent
`thought_scenario`	JSON	Optional
`thought_scenario (anyOf 1)`	string	Alternative	Scenario in which a thought was generated. Note: Stored as VARCHAR in the database (not a PostgreSQL ENUM), so new values can be added without database migrations. See observer_thoughts.observer_thought_scenario column. Known values: generate_plan, user_goal_check, failure_describe, summarization, generate_metadata, extract_loop_values, generate_task_in_loop, generate_general_task, termination
`thought_scenario (anyOf 2)`	null	Alternative
`thought_type`	JSON	Optional	Default: plan
`thought_type (anyOf 1)`	string	Alternative	Type of thought recorded during task execution. Note: Stored as VARCHAR in the database (not a PostgreSQL ENUM), so new values can be added without database migrations. See observer_thoughts.observer_thought_type column. Known values: plan, metadata, user_goal_check, internal_plan, failure_describe, termination
`thought_type (anyOf 2)`	null	Alternative
`user_input`	JSON	Optional
`user_input (anyOf 1)`	string	Alternative
`user_input (anyOf 2)`	null	Alternative
`workflow_id`	JSON	Optional
`workflow_id (anyOf 1)`	string	Alternative
`workflow_id (anyOf 2)`	null	Alternative
`workflow_permanent_id`	JSON	Optional
`workflow_permanent_id (anyOf 1)`	string	Alternative
`workflow_permanent_id (anyOf 2)`	null	Alternative
`workflow_run_block_id`	JSON	Optional
`workflow_run_block_id (anyOf 1)`	string	Alternative
`workflow_run_block_id (anyOf 2)`	null	Alternative
`workflow_run_id`	JSON	Optional
`workflow_run_id (anyOf 1)`	string	Alternative
`workflow_run_id (anyOf 2)`	null	Alternative

List runs — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	Lightweight run-history item backed by the task_runs table.
`created_at`	string	Required within parent	Format: date-time
`created_by`	JSON	Optional	ID of the user who started the run
`created_by (anyOf 1)`	string	Alternative
`created_by (anyOf 2)`	null	Alternative
`finished_at`	JSON	Optional
`finished_at (anyOf 1)`	string	Alternative	Format: date-time
`finished_at (anyOf 2)`	null	Alternative
`run_id`	string	Required within parent
`script_run`	boolean	Optional	Default: false
`started_at`	JSON	Optional
`started_at (anyOf 1)`	string	Alternative	Format: date-time
`started_at (anyOf 2)`	null	Alternative
`status`	string	Required within parent
`task_run_id`	string	Required within parent
`task_run_type`	string	Required within parent
`title`	JSON	Optional
`title (anyOf 1)`	string	Alternative
`title (anyOf 2)`	null	Alternative
`trigger_type`	JSON	Optional
`trigger_type (anyOf 1)`	Model	Alternative	Expand List runs — response body — item trigger type How a workflow run was initiated
`trigger_type (anyOf 2)`	null	Alternative
`workflow_deleted`	boolean	Optional	Default: false
`workflow_permanent_id`	JSON	Optional
`workflow_permanent_id (anyOf 1)`	string	Alternative
`workflow_permanent_id (anyOf 2)`	null	Alternative

Referenced models: List runs — response body — item trigger type How a workflow run was initiated

List runs — response body — item trigger type How a workflow run was initiated

Field	Type	Presence	Description and constraints
`$`	string	Root	How a workflow run was initiated. - manual: User clicked "Run" in the UI - mcp: First-party MCP client or Skyvern CLI request - api: Direct API call to the run endpoint - scheduled: Triggered by a cron schedule - webhook: Triggered by an external system via the webhook endpoint - event: Triggered by an external event source - job_recipe_extract: Launched by a job recipe extract request - job_recipe_apply: Launched by a job recipe apply request - seo_recipe_submit: Launched by an SEO recipe directory submission Known values: manual, mcp, api, scheduled, webhook, event, job_recipe_extract, job_recipe_apply, seo_recipe_submit

Replay a run webhook — request body — body webhook url

Field	Type	Presence	Description and constraints
`$`	object	Root
`webhook_url`	JSON	Optional	Optional webhook URL to send the payload to instead of the stored configuration
`webhook_url (anyOf 1)`	string	Alternative
`webhook_url (anyOf 2)`	null	Alternative

Replay a run webhook — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`default_webhook_url`	JSON	Optional	Webhook URL stored on the original run configuration
`default_webhook_url (anyOf 1)`	string	Alternative
`default_webhook_url (anyOf 2)`	null	Alternative
`error`	JSON	Optional	Error message if the replay attempt failed
`error (anyOf 1)`	string	Alternative
`error (anyOf 2)`	null	Alternative
`headers`	object	Required within parent	Signed headers that were generated for the replay attempt Additional keys: see wildcard field
`headers.*`	string	Additional keys
`latency_ms`	JSON	Optional	Round-trip latency in milliseconds for the replay attempt
`latency_ms (anyOf 1)`	JSON	Alternative
`latency_ms (anyOf 1) (anyOf 1)`	integer	Alternative
`latency_ms (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`latency_ms (anyOf 2)`	null	Alternative
`payload`	string	Required within parent	JSON payload that was delivered during the replay attempt
`response_body`	JSON	Optional	Body returned by the webhook receiver (truncated to 2KB)
`response_body (anyOf 1)`	string	Alternative
`response_body (anyOf 2)`	null	Alternative
`run_id`	string	Required within parent	Identifier of the run that was replayed
`run_type`	string	Required within parent	Run type associated with the payload
`status_code`	JSON	Optional	HTTP status code returned by the webhook receiver, if available
`status_code (anyOf 1)`	JSON	Alternative
`status_code (anyOf 1) (anyOf 1)`	integer	Alternative
`status_code (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`status_code (anyOf 2)`	null	Alternative
`target_webhook_url`	JSON	Optional	Webhook URL that the replay attempted to reach
`target_webhook_url (anyOf 1)`	string	Alternative
`target_webhook_url (anyOf 2)`	null	Alternative

Run an agent — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`agent_id`	string	Required within parent	ID of the agent to run. Starts with `wpid_`. `workflow_id` is accepted as an alias.
`ai_fallback`	JSON	Optional	Whether to fallback to AI if the workflow run fails.
`ai_fallback (anyOf 1)`	boolean	Alternative
`ai_fallback (anyOf 2)`	null	Alternative
`browser_address`	JSON	Optional	The CDP address for the workflow run.
`browser_address (anyOf 1)`	string	Alternative
`browser_address (anyOf 2)`	null	Alternative
`browser_profile_id`	JSON	Optional	ID of a browser profile to reuse for this workflow run
`browser_profile_id (anyOf 1)`	string	Alternative
`browser_profile_id (anyOf 2)`	null	Alternative
`browser_session_id`	JSON	Optional	ID of a Skyvern browser session to reuse, having it continue from the current screen state
`browser_session_id (anyOf 1)`	string	Alternative
`browser_session_id (anyOf 2)`	null	Alternative
`browser_type`	JSON	Optional	Browser engine for this run, one of the supported browser types (e.g. msedge, chrome, stealth-chromium). Overrides the workflow-level setting. Null inherits from the workflow.
`browser_type (anyOf 1)`	string	Alternative
`browser_type (anyOf 2)`	null	Alternative
`cdp_connect_headers`	JSON	Optional	HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Use this for browser-provider auth (e.g., x-api-key for Skyvern Cloud, Browserless, or similar). These headers are NEVER forwarded to target websites.
`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
`extra_http_headers`	JSON	Optional	The extra HTTP headers for the requests in browser.
`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
`file_ids`	JSON	Optional	Ids of files uploaded through `POST /v1/upload_file` to attach to this run. Skyvern deletes an attached file as soon as the run finishes, so there is nothing to clean up afterwards. Reference an attached file by its id anywhere a file URL is accepted (for example in `parameters` or in the prompt) and no presigned URL is ever created for it. A file can be attached to one run at a time, and must not already be deleted.
`file_ids (anyOf 1)`	array	Alternative	Maximum items: 50
`file_ids (anyOf 1)[]`	string	Each item
`file_ids (anyOf 2)`	null	Alternative
`max_elapsed_time_minutes`	JSON	Optional	Timeout this workflow run after the configured elapsed runtime in minutes. When omitted, the platform default is 240 minutes. The maximum configurable value is 480 minutes.
`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	The maximum number of scrolls for the post action screenshot. When it's None or 0, it takes the current viewpoint screenshot.
`max_screenshot_scrolls (anyOf 1)`	integer	Alternative
`max_screenshot_scrolls (anyOf 2)`	null	Alternative
`parameters`	JSON	Optional	Parameters to pass to the workflow
`parameters (anyOf 1)`	object	Alternative	Additional keys: allowed
`parameters (anyOf 2)`	null	Alternative
`proxy_location`	JSON	Optional	Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud. Available geotargeting options: - RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy. - RESIDENTIAL_ES: Spain - RESIDENTIAL_IE: Ireland - RESIDENTIAL_GB: United Kingdom - RESIDENTIAL_IN: India - RESIDENTIAL_JP: Japan - RESIDENTIAL_FR: France - RESIDENTIAL_DE: Germany - RESIDENTIAL_NZ: New Zealand - RESIDENTIAL_PH: Philippines - RESIDENTIAL_KR: South Korea - RESIDENTIAL_SA: Saudi Arabia - RESIDENTIAL_ZA: South Africa - RESIDENTIAL_AR: Argentina - RESIDENTIAL_AU: Australia - RESIDENTIAL_BR: Brazil - RESIDENTIAL_TR: Turkey - RESIDENTIAL_CA: Canada - RESIDENTIAL_MX: Mexico - RESIDENTIAL_IT: Italy - RESIDENTIAL_NL: Netherlands - RESIDENTIAL_ISP: ISP proxy - US-CA: California (deprecated, routes through RESIDENTIAL_ISP) - US-NY: New York (deprecated, routes through RESIDENTIAL_ISP) - US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP) - US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP) - US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP) - NONE: No proxy For self-hosted deployments, you can pass a custom proxy URL as a dict: {"url": "http://user:password@proxy.example:8080"}. This routes the browser through your own proxy server and takes precedence over any globally configured proxy pool. Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"} Default: RESIDENTIAL
`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`	JSON	Optional	Override whether this run reuses the workflow's managed browser session. Null inherits the workflow setting. Without login credentials, a browser profile key, or a sequential key, reuse is workflow-scoped: every run shares one browser and its signed-in state, so treat the workflow as single-account.
`reuse_browser_session (anyOf 1)`	boolean	Alternative
`reuse_browser_session (anyOf 2)`	null	Alternative
`run_metadata`	JSON	Optional	String key/value metadata to attach to this workflow run for analytics tag filtering.
`run_metadata (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`run_metadata (anyOf 1).*`	string	Additional keys
`run_metadata (anyOf 2)`	null	Alternative
`run_with`	JSON	Optional	Whether to run the workflow with agent or code. Null inherits from the workflow setting.
`run_with (anyOf 1)`	string	Alternative
`run_with (anyOf 2)`	null	Alternative
`start_fresh_browser`	boolean	Optional	When true, start this run from a fresh, empty browser and ignore any saved browser memory — no memory is read or written. A verified sign-in during the run still updates the credential's saved login. Default: false
`title`	JSON	Optional	The title for this workflow run
`title (anyOf 1)`	string	Alternative
`title (anyOf 2)`	null	Alternative
`totp_identifier`	JSON	Optional	Identifier for the TOTP/2FA/MFA code when the code is pushed to Skyvern. Refer to https://www.skyvern.com/docs/credentials#push-a-code for more details.
`totp_identifier (anyOf 1)`	string	Alternative
`totp_identifier (anyOf 2)`	null	Alternative
`totp_url`	JSON	Optional	URL that serves TOTP/2FA/MFA codes for Skyvern to use during the workflow run. Refer to https://www.skyvern.com/docs/credentials#let-skyvern-fetch-codes-from-your-endpoint for more details.
`totp_url (anyOf 1)`	string	Alternative
`totp_url (anyOf 2)`	null	Alternative
`webhook_url`	JSON	Optional	URL to send workflow status updates to after a run is finished. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for webhook questions.
`webhook_url (anyOf 1)`	string	Alternative
`webhook_url (anyOf 2)`	null	Alternative

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

Report an issue with this page