POST
/
api
/
session

Authorizations

​
x-api-key
string
headerrequired

Body

application/json
​
proxyServer
string
​
proxyServerPassword
string
​
proxyServerUsername
string
​
proxyCountry
enum<string>
default: US
Available options:
US,
GB,
CA
​
operatingSystems
enum<string>[]
Available options:
windows,
android,
macos,
linux,
ios
​
device
enum<string>[]
Available options:
desktop,
mobile
​
platform
enum<string>[]
Available options:
chrome,
firefox,
safari,
edge
​
locales
enum<string>[]
Available options:
en,
es,
fr
​
screen
object

Response

200 - application/json
​
id
string
​
status
enum<string>
Available options:
active,
closed,
error
​
startTime
string | null
​
endTime
string | null
​
createdAt
string
​
updatedAt
string
​
closeReason
string | null
​
dataConsumed
string
​
sessionUrl
string
​
wsEndpoint
string
IntroductionGet session by ID