Step API Reference

Create Session

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

Request

This endpoint expects an object.
url
stringRequired
The URL to create or continue session from.
local
booleanOptional
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_id
stringOptional
The agent id to use for the session.
mode
enumOptional
The mode you would like to use for the session. 'fast' or 'standard'
Allowed values: faststandard
use_proxy
booleanOptional
Boolean flag to use a proxy for the session (Default: False). Each Session gets a new Residential IP.
browser_params
objectOptional
Object containing height and width for the browser screen size.
include_screenshot
booleanOptional

Response

This endpoint returns an object
status
string

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

message
string
A message providing more details about the session status.
session_id
string
The unique identifier for the session.
url
string
The URL associated with the session.
screenshot
string
image url of the screenshot taken during the session.