Observe page
This endpoint observes the actions available on a given URL within the session’s environment.
Parameters
Optional parameter to specify the session ID. The session ID of the session within which the environment will be observed.
Required parameter to specify the URL to observe. The URL to analyze and fetch available actions.
Optional parameter to keep the session alive beyond its timeout period.
Default is false.
Optional parameter to set a custom timeout for the session.
Specify the timeout in minutes. Default is 10.
Response
The unique identifier for the session used in the observation.
The title of the observed page.
The URL of the observed page.
The timestamp when the observation was performed, in ISO 8601 format.
A base64-encoded screenshot of the observed page, if requested.
The data retrieved during the observation.
The available action space, 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
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 < 30The URL to observe. If not provided, uses the current page URL.
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