Step API Reference

Create Session

Creates a new session and returns session details including a unique session ID. A session remains active for 10 minutes of inactivity.

Headers

X_MULTION_API_KEYstringRequired

Request

This endpoint expects an object.
urlstringRequired
The URL to create or continue session from.
localbooleanOptional

Boolean flag to indicate if session to be run locally or in the cloud (Default: False). If set to true, the session will be run locally via your chrome extension. If set to false, the session will be run in the cloud.

agent_idstringOptional
The agent id to use for the session.
modeenumOptional
The mode you would like to use for the session. 'fast' or 'standard'
Allowed values:
use_proxybooleanOptional

Boolean flag to use a proxy for the session (Default: False). Each Session gets a new Residential IP.

browser_paramsobjectOptional
Object containing height and width for the browser screen size.
include_screenshotbooleanOptional
optional_paramsmap from strings to anyOptional
Additional optional parameters for the session.

Response

This endpoint returns an object.
statusstring

The final status of the browsing session. One of [“CONTINUE”, “ASK_USER”, “DONE”]

messagestring
A message providing more details about the session status.
session_idstring
The unique identifier for the session.
urlstring
The URL associated with the session.
screenshotstring
image url of the screenshot taken during the session.

Errors