POST
/
env
/
step

Parameters

session_id (req)
string

Required parameter to specify the session ID. The session ID of the active browser session.

action_id (req)
string

Required parameter to specify the action ID. The ID of the action to execute within the environment.

value (opt)
string

Optional parameter to provide input or parameters for the action. Specify any required input values for the action being executed.

enter (opt)
boolean

Optional parameter to specify whether to confirm the action (e.g., pressing Enter). Default is false.

Response

session_id
string

The unique identifier for the session where the action was executed.

title
string

The title of the resulting page after executing the action.

url
string

The URL of the resulting page after executing the action.

timestamp
string

The timestamp when the action was executed, in ISO 8601 format.

screenshot
string (base64) (opt)

A base64-encoded screenshot of the resulting page, if available.

data
string

The data retrieved from the resulting page after the action.

space
object (opt)

The available action space after the execution, including descriptions and categories.

Error Responses

400
string

Invalid request. This error is returned when the input parameters are not valid or a required parameter is missing.

500
string

Internal server error. This error is returned when the server encounters an unexpected condition.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
action_id
string
required

The ID of the action to execute

enter
boolean | null

Whether to press enter after inputting the value

keep_alive
boolean
default:
false

If True, the session will not be closed after the operation is completed.

max_nb_actions
integer
default:
100

The maximum number of actions to list after which the listing will stop. Used when min_nb_actions is not provided.

min_nb_actions
integer | null

The minimum number of actions to list before stopping. If not provided, the listing will continue until the maximum number of actions is reached.

screenshot
boolean | null

Whether to include a screenshot in the response.

session_id
string | null

The ID of the session. A new session is created when not provided.

session_timeout_minutes
integer
default:
5

Session timeout in minutes. Cannot exceed the global timeout.

Required range: 0 < x < 30
value
string | null

The value to input for form actions

Response

200 - application/json
metadata
object
required

Metadata of the current page, i.e url, page title, snapshot timestamp.

session
object
required

Browser session information

data
object | null

Extracted data from the page

screenshot
file | null

Base64 encoded screenshot of the current page

space
object | null

Available actions in the current state