Hyperbrowser home page
Search...
Dashboard
Support
Dashboard
Search...
Navigation
API Reference
Get session by ID
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 session by ID
GET
/
api
/
session
/
{id}
Send
Authorization
x-api-key
string
*
x-api-key
Required
string
Path
id
string
*
id
Required
string
Authorizations
x-api-key
string
header
required
Path Parameters
id
string
required
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
Create new session
Stop a session