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 Web API

Stateless web utilities: fetch a single page, run a web search, or start a crawl. Includes `/x402` micropayment-gated variants of fetch and search for permissionless, pay-per-call usage.

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

Tagged areas include Web, Fetch, Search, and X402. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 7 operations across 7 paths, and defines 40 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.

7 operations 7 paths 40 schemas 2 GET5 POST

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 Web 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 7

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

Web 7
POST
/api/web/fetch
Fetch a web page
body → 200400500
POST
/api/web/search
Search the web
body → 200400500
POST
/api/web/crawl
Start a web crawl job
body → 200400500
GET
/api/web/crawl/{id}
Get web crawl job results
3 params → 200404500
GET
/api/web/crawl/{id}/status
Get web crawl job status
1 param → 200404500
POST
/x402/web/fetch
Fetch a Web Page with X402 Payment
post-x402-web-fetch 1 param body → 200400402500
POST
/x402/web/search
Search the Web with X402 Payment
post-x402-web-search 1 param body → 200400402500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are BrandingProfile (10 properties), WebCrawlPageData (10 properties), WebSearchFilters (9 properties), WebCrawlJobResponse (8 properties). Each schema is shown below with its type and property counts.

WebSearchResponseData
object
2 properties 2 required
WebSearchParams
object
5 properties 1 required
FetchParams
object
6 properties 1 required
FetchOutputScreenshotOptions
object
5 properties
FetchSanitizeMode
string
WebCrawlPageData
object
10 properties 2 required
FetchScreenshotFormat
string
WebSearchResponse
object
4 properties 2 required
WebSearchFilters
object
9 properties
FetchStealthMode
string
JobStatus
string
FetchOutputMarkdown
object
1 property 1 required
FetchBrowserLocationOptions
object
3 properties
FetchResponse
object
4 properties 2 required
WebCrawlJobResponse
object
8 properties 2 required
FetchOutputJson
WebSearchResultItem
object
3 properties 3 required
FetchNavigationOptions
object
3 properties
StartWebCrawlJobParams
object
7 properties 1 required
ScreenConfig
object
2 properties
FetchOutputScreenshot
FetchStatus
string
WebSearchFiletype
string
FetchOutputBranding
object
1 property 1 required
FetchCacheOptions
object
1 property
FetchWaitUntil
string
JobStatusResponse
object
1 property 1 required
BrandingProfile
object
Visual brand profile extracted via DOM analysis + LLM enhancement. All fields optional; the server may return a partial profile when the LLM refuses or fails.
10 properties
FetchOutputOptions
object
5 properties
PageStatus
string
ErrorResponse
object
1 property
FetchOutputHtml
object
1 property 1 required
FetchOutputLinks
object
1 property 1 required
FetchStorageStateOptions
object
2 properties
FetchOutputJsonOptions
object
2 properties
FetchBrowserOptions
object
4 properties
WebSearchStatus
string
WebCrawlOptions
object
5 properties
WebSearchLocation
object
3 properties 1 required
FetchResponseData
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperbrowser-web-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 Profile API
Hyperbrowser Session API
Hyperbrowser Task API
Hyperbrowser X402 API