Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hyperbrowser Session API

The Session API from Hyperbrowser — 8 operation(s) for session.

Hyperbrowser Session API is one of 12 APIs that Hyperbrowser publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Session. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 8 paths, and defines 36 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.hyperbrowser.ai.

8 operations 8 paths 36 schemas 4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.hyperbrowser.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Hyperbrowser Session API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Account API key from app.hyperbrowser.ai

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Session 8
POST
/api/session
Create new session
body → 200
GET
/api/session/{id}
Get session by ID
1 param → 200404
PUT
/api/session/{id}/stop
Stop a session
1 param → 200404500
PUT
/api/session/{id}/update
Update a running session
1 param body → 200400404409500
POST
/api/session/{id}/captcha/evaluate
Run manual CAPTCHA evaluation
1 param body → 200400404409500
GET
/api/session/{id}/recording-url
Get session recording URL
1 param → 200404500
GET
/api/session/{id}/video-recording-url
Get session video recording URL
1 param → 200404500
GET
/api/session/{id}/downloads-url
Get session downloads URL
1 param → 200404500

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are CreateSessionParams (37 properties), SessionLaunchState (22 properties), Session (9 properties), CaptchaEvaluationParams (8 properties). Each schema is shown below with its type and property counts.

SessionDetail
UpdateSessionProfileRequest
object
2 properties 2 required
CaptchaEvaluationType
string
CAPTCHA target to evaluate manually.
GetSessionRecordingUrlResponse
object
3 properties 1 required
ProxyCountry
string
CaptchaEvaluationParams
object
8 properties
Device
string
ProxyState
string
Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.
SessionRegion
string
CreateSessionProfile
object
3 properties
GetSessionVideoRecordingUrlResponse
object
3 properties 1 required
DownloadsStatus
string
UpdateSessionProfileParams
object
2 properties
ScreenConfig
object
2 properties
UpdateSessionProxyLocationParams
object
3 properties
ISO639_1
string
SessionLaunchState
object
22 properties
CreateSessionParams
object
37 properties
ImageCaptchaParam
object
2 properties
CaptchaEvaluationPageResult
object
8 properties
BasicResponse
object
1 property
UpdateSessionRequest
Platform
string
GetSessionDownloadsUrlResponse
object
3 properties 1 required
OperatingSystem
string
RecordingStatus
string
CaptchaEvaluationResponse
object
7 properties
ErrorResponse
object
1 property
UpdateSessionSolveCaptchasRequest
object
2 properties 2 required
UpdateSessionResponse
UpdateSessionSolveCaptchasParams
object
2 properties 1 required
Session
object
9 properties
UpdateSessionProxyParams
object
3 properties 1 required
UpdateSessionScreenParams
object
2 properties 2 required
UpdateSessionScreenRequest
object
2 properties 2 required
UpdateSessionProxyRequest
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperbrowser-session-api-openapi.yml Raw ↑

Other APIs Hyperbrowser publishes across the network.

Hyperbrowser Sessions API
Hyperbrowser Profiles API
Hyperbrowser Scrape API
Hyperbrowser Crawl API
Hyperbrowser Extract API
Hyperbrowser Agents API
Hyperbrowser Extensions API
Hyperbrowser Web API
Hyperbrowser Profile API
Hyperbrowser Task API
Hyperbrowser X402 API