​
Constructor

simplex_client = Simplex(
    api_key: str
)
​
api_key
string
required

API key for authentication.

​
Session Creation

def create_session(
  show_in_console: Optional[bool] = True,
  proxies: Optional[bool] = True,
  workflow_name: Optional[str] = None,
  session_data: Optional[str] = None
) -> Tuple[str, str]

Creates the remote browser session on the Simplex client.

​
show_in_console
bool

Whether to print the livestream URL to the console.

​
proxies
bool

Whether to use proxies to create the session. By default, proxies are used to help with session stability. If you’re having trouble connecting to a website, you can try setting this to False.

​
workflow_name
string

Optional name for the workflow being executed.

​
session_data
str

Credentials data for the session created using capture_login_session or the simplex login CLI method.

​
return
Tuple[str, str]

The session id of the current session and a livestream URL of the current session. The livestream URL can be used for debugging and monitoring the session.

​
Session Closing

def close_session() -> None

Closes the remote browser session that was started with the create_session method.

​
return
None