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

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

Hyperbrowser Crawl API is one of 12 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 15 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.

3 operations 3 paths 15 schemas 2 GET1 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 Crawl 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 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
post-api-crawl body → 200400500
GET
/api/crawl/{id}
Get Crawl Job Status and Results
get-api-crawl-id 3 params → 200404500
GET
/api/crawl/{id}/status
Get Crawl Job Status
get-api-crawl-id-status 1 param → 200404500

Schemas 15

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

ErrorResponse
object
1 property
ISO639_1
string
ProxyCountry
string
CreateSessionParams
object
37 properties
Device
string
CrawledPage
object
8 properties 2 required
CreateSessionProfile
object
3 properties
JobStatus
string
SessionRegion
string
JobStatusResponse
object
1 property 1 required
ProxyState
string
Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.
Platform
string
ScrapeOptions
object
9 properties
OperatingSystem
string
ScreenConfig
object
2 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 Agents API
Hyperbrowser Extensions API
Hyperbrowser Web API
Hyperbrowser Profile API
Hyperbrowser Session API
Hyperbrowser Task API
Hyperbrowser X402 API