Hyperbrowser home page
Search...
Dashboard
Support
Dashboard
Search...
Navigation
API Reference
Get list of sessions
Documentation
API Reference
Documentation
Community
API Documentation
Introduction
API Reference
POST
Create new session
GET
Get session by ID
PUT
Stop a session
GET
Get list of sessions
POST
Create new scrape job
GET
Get scrape job status and result
POST
Start a crawl job
GET
Get crawl job status and results
API Reference
Get list of sessions
GET
/
api
/
sessions
Send
Authorization
x-api-key
string
*
x-api-key
Required
string
Query
page
number
page
number
status
enum<string>
Select option
status
enum<string>
Authorizations
x-api-key
string
header
required
Query Parameters
page
number
default: 1
status
enum<string>
Available options:
active
,
closed
,
error
Response
200 - application/json
sessions
object[]
Show child attributes
sessions.
id
string
sessions.
status
enum<string>
Available options:
active
,
closed
,
error
sessions.
startTime
string | null
sessions.
endTime
string | null
sessions.
createdAt
string
sessions.
updatedAt
string
sessions.
closeReason
string | null
sessions.
dataConsumed
string
totalCount
number
page
number
pageSize
number
Stop a session
Create new scrape job