curl --request POST \
  --url https://api.simplex.sh/create_login_session \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "url": "https://example.com/login",
  "proxies": true
}'
{
  "succeeded": true,
  "login_session_url": "https://simplex.sh/login-session?sess=b1b61345-9800-4808-9973-dbc2fv3f98af"
}

Authorizations

​
X-API-Key
string
header
required

Simplex API Key to authenticate requests. We provision API keys after a quick meeting with us. You can book that meeting here.

Body

application/json
​
url
string
required

The URL of the website to capture the login session from.

Example:

"https://example.com/login"

​
proxies
boolean

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 the website, you can try setting this to false. Not required.

Response

200
application/json
Create login session response
​
succeeded
boolean
required

Indicates if the login session was successfully created.

Example:

true

​
login_session_url
string

The URL of the login session to visit and login to.

Example:

"https://simplex.sh/login-session?sess=b1b61345-9800-4808-9973-dbc2fv3f98af"

Was this page helpful?