Start Session
This endpoint starts a new session and returns a session ID. An existing session cannot provide a session ID during creation.
Parameters
Optional parameter to specify a session ID.
Session ID should not be provided when starting a new session. Use observe to interact with existing sessions.
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.
Optional parameter to request a screenshot during the session.
Default is null (no screenshot).
Response
The unique identifier for the created session.
An optional error message if something goes wrong during session creation.
Error Responses
Invalid request. This error is returned when the input parameters are not valid.
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.
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 < 30Response
Session creation time
Session duration
Last access time
The ID of the session (created or existing). Use this ID to interact with the session for the next operation.
Session status
active, closed, error, timed_out Session timeout in minutes. Will timeout if now() > last access time + timeout_minutes
Error message if the operation failed to complete