Skip to main content
POST
/
browser
/
v1
/
sessions
Open a browser session
curl --request POST \
  --url https://api.voyant.travel/browser/v1/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "keepAliveMs": 123
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "browserMsUsed": 123,
  "commandCount": 123,
  "keepAliveMs": 123,
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "apiTokenId": "<string>",
  "label": "<string>",
  "closedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Voyant Cloud API token, passed as Authorization: Bearer <token>. Each token carries a fixed set of scopes; an operation rejects tokens missing its required scope.

Body

application/json
​
label
string | null

Human-readable label persisted on the session record.

​
keepAliveMs
integer

Keep-alive duration in milliseconds. Capped server-side at 1 hour.

Response

200 - application/json

Session opened

​
id
string
required
​
organizationId
string
required
​
status
enum<string>
required
Available options:
active,
closed,
expired
​
browserMsUsed
integer
required
​
commandCount
integer
required
​
keepAliveMs
integer
required
​
lastUsedAt
string<date-time>
required
​
createdAt
string<date-time>
required
​
apiTokenId
string | null
​
label
string | null
​
closedAt
string<date-time> | null