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

Hyperbrowser Crawl API

Recursive crawl jobs across many pages with structured page-by-page results and status polling.

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

This API exposes 1 JSON Schema definition.

Tagged areas include Crawl and Web Crawling. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 JSON Schema.

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

3 operations 3 paths 17 schemas 2 GET1 POST

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 Crawl 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 3

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

Crawl 3
POST
/api/crawl
Start a crawl job
postApiCrawl body → 200400500
GET
/api/crawl/{id}
Get crawl job status and results
getApiCrawlById 3 params → 200404500
GET
/api/crawl/{id}/status
Get crawl job status
getApiCrawlByIdStatus 1 param → 200404500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are CreateSessionParams (41 properties), ScrapeOptions (9 properties), CrawledPage (8 properties), CreateSessionProfile (3 properties). Each schema is shown below with its type and property counts.

WebBotAuthParams
object
Limits Web Bot Auth signing to some hosts.
1 property
OperatingSystem
string
JobStatusResponse
object
1 property 1 required
ProxyState
stringnull
Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.
CrawledPage
object
8 properties 2 required
CreateSessionParams
object
41 properties
ErrorResponse
object
1 property
ProxyCountry
string
Device
string
ScrapeOptions
object
9 properties
JobStatus
string
Platform
string
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…
ScreenConfig
object
2 properties
ISO639_1
string
ProxyRoute
object
Sends traffic for matching hosts through the session's proxy or straight out.
2 properties 2 required
CreateSessionProfile
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperbrowser-crawl-api-openapi.yml Raw ↑

Other APIs Hyperbrowser publishes across the network.

Hyperbrowser Sessions API
Hyperbrowser Profiles API
Hyperbrowser Scrape API
Hyperbrowser Extract API
Hyperbrowser Extensions API
Hyperbrowser Web API
Hyperbrowser Profile API
Hyperbrowser Session API
Hyperbrowser Task API
Hyperbrowser X402 API
Hyperbrowser Images API
Hyperbrowser Sandboxes API
Where this information came from

This is an independent, third-party profile of Hyperbrowser Crawl 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.