How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Hyperbrowser

Hyperbrowser Session API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 14 operations across 14 paths, and defines 60 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

14 operations 14 paths 60 schemas 6 GET6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.hyperbrowser.ai
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Hyperbrowser Session API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (X402SessionManagement).

  • X402SessionManagement — The managementToken from the X402 session purchase response. Valid for 24 hours and scoped to that session; no API key or further payment is required.

Paths & Operations 14

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

Session 14
POST
/api/session
Create new session
postApiSession body → 200
GET
/api/session/{id}
Get session by ID
getApiSessionById 1 param → 200404
PUT
/api/session/{id}/stop
Stop a session
putApiSessionByIdStop 1 param → 200404500
PUT
/api/session/{id}/update
Update a running session
putApiSessionByIdUpdate 1 param body → 200400404409500
POST
/api/session/{id}/captcha/evaluate
Run manual CAPTCHA evaluation
postApiSessionByIdCaptchaEvaluate 1 param body → 200400404409500
GET
/api/session/{id}/recording-url
Get session recording URL
getApiSessionByIdRecordingUrl 1 param → 200404500
GET
/api/session/{id}/video-recording-url
Get session video recording URL
getApiSessionByIdVideoRecordingUrl 1 param → 200404500
GET
/api/session/{id}/downloads-url
Get session downloads URL
getApiSessionByIdDownloadsUrl 1 param → 200404500
GET
/api/session/{id}/webmcp/tools
List WebMCP tools
listWebmcpTools 1 param → 200400401403404409429500
POST
/api/session/{id}/webmcp/invoke
Invoke a WebMCP tool
invokeWebmcpTool 1 param body → 200400401403404409429500
POST
/api/session/{id}/webmcp/invocations
Start a WebMCP invocation
startWebmcpInvocation 1 param body → 202400401403404409429500
GET
/api/session/{id}/webmcp/invocations/{invocationId}
Get a WebMCP invocation result
getWebmcpInvocationResult 3 params → 200400401403404409429500
POST
/api/session/{id}/webmcp/invocations/{invocationId}/cancel
Cancel a WebMCP invocation
cancelWebmcpInvocation 2 params → 200400401403404409429500
POST
/api/session/{id}/credentials/fill
Fill a credential
fillSessionCredential 1 param body → 200400401403404409422429

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are CreateSessionParams (41 properties), SessionLaunchState (24 properties), WebMCPTool (10 properties), Session (9 properties). Each schema is shown below with its type and property counts.

CaptchaEvaluationResponse
object
7 properties
Session
object
9 properties
SessionWebBotAuth
object
How a session signs its requests with Web Bot Auth.
2 properties 1 required
WebMCPFrame
object
3 properties 3 required
CredentialFillResponse
object
What was typed where. Never contains values.
4 properties 3 required
CreateSessionParams
object
41 properties
WebMCPInvocation
object
Ephemeral, session-local handle. Pending states have no result or error. A terminal handle may contain a result or an error. Lost on receiver restart, session…
8 properties 5 required
CredentialFillParams
object
Provide exactly one of credential, vault and onePassword (otherwise 400 "Pass one of credential, vault or onePassword"). With vault, every field has field; wit…
7 properties 1 required
ProxyCountry
string
UpdateSessionRequest
GetSessionVideoRecordingUrlResponse
object
3 properties 1 required
SessionRegion
string
Region to run the session in. The asia-south region is only available on Enterprise and Select plans. Get in touch at https://calendly.com/shri-hyperbrowser/de…
CreateSessionResponse
SecretErrorResponse
object
HTTP failure. Secret errors include code and message; request validation errors include only message; API key scope errors include error, message and requiredS…
6 properties
ISO639_1
string
UpdateSessionScreenParams
object
2 properties 2 required
CredentialFillOutcome
string
filled: the input now holds exactly the value. notfound: no input matched the selector. ambiguous: more than one visible input matched. noteditable: the input…
UpdateSessionSolveCaptchasParams
object
2 properties 1 required
CreateSessionProfile
object
3 properties
UpdateSessionProxyRequest
object
2 properties 2 required
ErrorResponse
object
1 property
UpdateSessionProfileParams
object
2 properties
CredentialFillField
object
3 properties 1 required
SessionLaunchState
objectnull
24 properties
WebMCPStartParams
object
3 properties 1 required
OnePasswordField
object
A field of an item in the request's 1Password vault (onePassword.vault), read as op:// / /[ /] . The whole reference can be at most 512 bytes of UTF-8.
3 properties 2 required
UpdateSessionProxyParams
object
3 properties 1 required
WebMCPAnnotations
object
Page-provided hints, not a security or authorization guarantee. Destructive, idempotent, and openWorld are optional polyfill hints.
7 properties 4 required
UpdateSessionScreenRequest
object
2 properties 2 required
OperatingSystem
string
DownloadsStatus
string
SessionDetail
WebMCPTool
object
10 properties 6 required
UpdateSessionProfileRequest
object
2 properties 2 required
WebMCPInvocationError
object
2 properties 2 required
ProxyState
stringnull
Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.
WebBotAuthParams
object
Limits Web Bot Auth signing to some hosts.
1 property
WebMCPInvokeResult
object
9 properties 4 required
BasicResponse
object
1 property 1 required
ImageCaptchaParam
object
2 properties
CaptchaEvaluationType
string
CAPTCHA target to evaluate manually.
UpdateSessionProxyLocationParams
object
3 properties
CredentialFillOnePassword
object
Fill fields read from 1Password with an optoken secret attached to the session as {"onePassword": name} in credentials (otherwise 403 CREDENTIALNOTATTACHED). E…
3 properties 3 required
UpdateSessionResponse
RecordingStatus
string
ProxyRoute
object
Sends traffic for matching hosts through the session's proxy or straight out.
2 properties 2 required
WebMCPToolsResponse
object
3 properties 3 required
Platform
string
WebMCPErrorResponse
object
HTTP failure. Structured WebMCP errors include message and code; other session or validation errors may only include error or message. An outcomeunknown error…
4 properties
SessionCredential
object
2 properties 2 required
GetSessionDownloadsUrlResponse
object
3 properties 1 required
WebMCPSource
object
5 properties 5 required
CredentialFillFieldResult
object
7 properties 4 required
CaptchaEvaluationPageResult
object
8 properties
ScreenConfig
object
2 properties
GetSessionRecordingUrlResponse
object
3 properties 1 required
CaptchaEvaluationParams
object
8 properties
UpdateSessionSolveCaptchasRequest
object
2 properties 2 required
WebMCPInvokeParams
object
3 properties 1 required
Device
string

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
AE Profile APIs.io
Hyperbrowser Profiles API
AE Profile APIs.io
Hyperbrowser Scrape API
AE Profile APIs.io
Hyperbrowser Crawl API
AE Profile APIs.io
Hyperbrowser Extract API
AE Profile APIs.io
Hyperbrowser Extensions API
AE Profile APIs.io
Hyperbrowser Web API
AE Profile APIs.io
Hyperbrowser Profile API
AE Profile APIs.io
Hyperbrowser Task API
AE Profile APIs.io
Hyperbrowser X402 API
AE Profile APIs.io
Hyperbrowser Images API
AE Profile APIs.io
Hyperbrowser Sandboxes API
AE Profile APIs.io
#Sessions
← Back to H APIs
API Details
ID
hyperbrowser:hyperbrowser-session-api
Base URL
https://api.hyperbrowser.ai
Docs
https://docs.hyperbrowser.ai/sessions/overview
Provider
Hyperbrowser
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=hyperbrowser-session-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/hyperbrowser-session-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Hyperbrowser Session API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.