Step in page
This endpoint executes an action in an active browser session and observes the resulting state.
Parameters
Required parameter to specify the session ID. The session ID of the active browser session.
Required parameter to specify the action ID. The ID of the action to execute within the environment.
Optional parameter to provide input or parameters for the action. Specify any required input values for the action being executed.
Optional parameter to specify whether to confirm the action (e.g., pressing Enter).
Default is false
.
Response
The unique identifier for the session where the action was executed.
The title of the resulting page after executing the action.
The URL of the resulting page after executing the action.
The timestamp when the action was executed, in ISO 8601 format.
A base64-encoded screenshot of the resulting page, if available.
The data retrieved from the resulting page after the action.
The available action space after the execution, including descriptions and categories.
Error Responses
Invalid request. This error is returned when the input parameters are not valid or a required parameter is missing.
Internal server error. This error is returned when the server encounters an unexpected condition.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
The ID of the action to execute
Whether to press enter after inputting the value
If True, the session will not be closed after the operation is completed.
The maximum number of actions to list after which the listing will stop. Used when min_nb_actions is not provided.
The minimum number of actions to list before stopping. If not provided, the listing will continue until the maximum number of actions is reached.
Whether to include a screenshot in the response.
The ID of the session. A new session is created when not provided.
Session timeout in minutes. Cannot exceed the global timeout.
0 < x < 30
The value to input for form actions
Response
Metadata of the current page, i.e url, page title, snapshot timestamp.
Browser session information
Extracted data from the page
Base64 encoded screenshot of the current page
Available actions in the current state