Skyvern: Sdk schemas

← Sdk operations · All schemas

Run an SDK action — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request to run a single SDK action.
action	JSON	Required within parent	The action to execute with its specific parameters
action (oneOf 1)	Model	Alternative	Expand Run an SDK action — request body — body action type ai click
action (oneOf 2)	Model	Alternative	Expand Run an SDK action — request body — body action type ai input text
action (oneOf 3)	Model	Alternative	Expand Run an SDK action — request body — body action type ai select option
action (oneOf 4)	Model	Alternative	Expand Run an SDK action — request body — body action type ai upload file
action (oneOf 5)	Model	Alternative	Expand Run an SDK action — request body — body action type ai act
action (oneOf 6)	Model	Alternative	Expand Run an SDK action — request body — body action type extract
action (oneOf 7)	Model	Alternative	Expand Run an SDK action — request body — body action type locate element
action (oneOf 8)	Model	Alternative	Expand Run an SDK action — request body — body action type validate
action (oneOf 9)	Model	Alternative	Expand Run an SDK action — request body — body action type prompt
browser_address	JSON	Optional	The browser address
browser_address (anyOf 1)	string	Alternative
browser_address (anyOf 2)	null	Alternative
browser_session_id	JSON	Optional	The browser session ID
browser_session_id (anyOf 1)	string	Alternative
browser_session_id (anyOf 2)	null	Alternative
url	string	Required within parent	The URL where the action should be executed
workflow_run_id	JSON	Optional	Optional workflow run ID to continue an existing workflow run
workflow_run_id (anyOf 1)	string	Alternative
workflow_run_id (anyOf 2)	null	Alternative

Referenced models: Run an SDK action — request body — body action type ai act, Run an SDK action — request body — body action type ai click, Run an SDK action — request body — body action type extract, Run an SDK action — request body — body action type ai input text, Run an SDK action — request body — body action type locate element, Run an SDK action — request body — body action type prompt, Run an SDK action — request body — body action type ai select option, Run an SDK action — request body — body action type ai upload file, Run an SDK action — request body — body action type validate

Run an SDK action — request body — body action type ai act

Field	Type	Presence	Description and constraints
$	object	Root	AI act action parameters.
data	JSON	Optional	Additional context data
data (anyOf 1)	string	Alternative
data (anyOf 2)	object	Alternative	Additional keys: allowed
data (anyOf 3)	null	Alternative
intention	string	Optional	Natural language prompt for the action Default:
type	string	Required within parent	Must equal: ai_act Default: ai_act

Run an SDK action — request body — body action type ai click

Field	Type	Presence	Description and constraints
$	object	Root	Click action parameters.
data	JSON	Optional	Additional context data
data (anyOf 1)	string	Alternative
data (anyOf 2)	object	Alternative	Additional keys: allowed
data (anyOf 3)	null	Alternative
intention	string	Optional	The intention or goal of the click Default:
selector	JSON	Optional	CSS selector for the element Default:
selector (anyOf 1)	string	Alternative
selector (anyOf 2)	null	Alternative
timeout	number	Optional	Timeout in milliseconds Default: 10000
type	string	Required within parent	Must equal: ai_click Default: ai_click

Run an SDK action — request body — body action type ai input text

Field	Type	Presence	Description and constraints
$	object	Root	Input text action parameters.
data	JSON	Optional	Additional context data
data (anyOf 1)	string	Alternative
data (anyOf 2)	object	Alternative	Additional keys: allowed
data (anyOf 3)	null	Alternative
intention	string	Optional	The intention or goal of the input Default:
selector	JSON	Optional	CSS selector for the element Default:
selector (anyOf 1)	string	Alternative
selector (anyOf 2)	null	Alternative
timeout	number	Optional	Timeout in milliseconds Default: 10000
totp_identifier	JSON	Optional	TOTP identifier for input_text actions
totp_identifier (anyOf 1)	string	Alternative
totp_identifier (anyOf 2)	null	Alternative
totp_url	JSON	Optional	TOTP URL for input_text actions
totp_url (anyOf 1)	string	Alternative
totp_url (anyOf 2)	null	Alternative
type	string	Required within parent	Must equal: ai_input_text Default: ai_input_text
value	JSON	Optional	Value to input Default:
value (anyOf 1)	string	Alternative
value (anyOf 2)	null	Alternative

Run an SDK action — request body — body action type ai select option

Field	Type	Presence	Description and constraints
$	object	Root	Select option action parameters.
data	JSON	Optional	Additional context data
data (anyOf 1)	string	Alternative
data (anyOf 2)	object	Alternative	Additional keys: allowed
data (anyOf 3)	null	Alternative
intention	string	Optional	The intention or goal of the selection Default:
selector	JSON	Optional	CSS selector for the element Default:
selector (anyOf 1)	string	Alternative
selector (anyOf 2)	null	Alternative
timeout	number	Optional	Timeout in milliseconds Default: 10000
type	string	Required within parent	Must equal: ai_select_option Default: ai_select_option
value	JSON	Optional	Value to select Default:
value (anyOf 1)	string	Alternative
value (anyOf 2)	null	Alternative

Run an SDK action — request body — body action type ai upload file

Field	Type	Presence	Description and constraints
$	object	Root	Upload file action parameters.
data	JSON	Optional	Additional context data
data (anyOf 1)	string	Alternative
data (anyOf 2)	object	Alternative	Additional keys: allowed
data (anyOf 3)	null	Alternative
file_url	JSON	Optional	File URL for upload Default:
file_url (anyOf 1)	string	Alternative
file_url (anyOf 2)	null	Alternative
intention	string	Optional	The intention or goal of the upload Default:
selector	JSON	Optional	CSS selector for the element Default:
selector (anyOf 1)	string	Alternative
selector (anyOf 2)	null	Alternative
timeout	number	Optional	Timeout in milliseconds Default: 10000
type	string	Required within parent	Must equal: ai_upload_file Default: ai_upload_file

Run an SDK action — request body — body action type extract

Field	Type	Presence	Description and constraints
$	object	Root	Extract data action parameters.
data	JSON	Optional	Additional context data
data (anyOf 1)	string	Alternative
data (anyOf 2)	object	Alternative	Additional keys: allowed
data (anyOf 3)	null	Alternative
error_code_mapping	JSON	Optional	Error code mapping for extraction
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
extract_schema	JSON	Optional	Schema for extraction
extract_schema (anyOf 1)	object	Alternative	Additional keys: allowed
extract_schema (anyOf 2)	array	Alternative
extract_schema (anyOf 2)[]	JSON	Each item
extract_schema (anyOf 3)	string	Alternative
extract_schema (anyOf 4)	null	Alternative
intention	JSON	Optional	The intention or goal of the extraction
intention (anyOf 1)	string	Alternative
intention (anyOf 2)	null	Alternative
prompt	string	Optional	Extraction prompt Default:
type	string	Required within parent	Must equal: extract Default: extract

Run an SDK action — request body — body action type locate element

Field	Type	Presence	Description and constraints
$	object	Root	Locate element action parameters.
prompt	string	Optional	Natural language prompt to locate an element Default:
type	string	Required within parent	Must equal: locate_element Default: locate_element

Run an SDK action — request body — body action type prompt

Field	Type	Presence	Description and constraints
$	object	Root	Prompt action parameters.
model	JSON	Optional	Optional model configuration
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
prompt	string	Required within parent	The prompt to send to the LLM
response_schema	JSON	Optional	Optional JSON schema to structure the response
response_schema (anyOf 1)	object	Alternative	Additional keys: allowed
response_schema (anyOf 2)	null	Alternative
type	string	Required within parent	Must equal: prompt Default: prompt

Run an SDK action — request body — body action type validate

Field	Type	Presence	Description and constraints
$	object	Root	Validate action parameters.
model	JSON	Optional	Optional model configuration
model (anyOf 1)	object	Alternative	Additional keys: allowed
model (anyOf 2)	null	Alternative
prompt	string	Required within parent	Validation criteria or condition to check
type	string	Required within parent	Must equal: validate Default: validate

Run an SDK action — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response from running an SDK action.
result	JSON	Optional	The result from the action (e.g., selector, value, extracted data)
result (anyOf 1)	JSON	Alternative
result (anyOf 2)	null	Alternative
workflow_run_id	string	Required within parent	The workflow run ID used for this action