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

Structured data extraction jobs that pull typed records from one or more pages using prompts and JSON schemas.

Hyperbrowser Extract 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 Extract, Structured Extraction, and Data Extraction. 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 16 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 16 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 Extract 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.

Extract 3
POST
/api/extract
Start an Extract Job
post-api-extract body → 200400500
GET
/api/extract/{id}
Get Extract Job Status and Results
get-api-extract-id 1 param → 200404500
GET
/api/extract/{id}/status
Get Extract Job Status
get-api-extract-id-status 1 param → 200404500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are CreateSessionParams (37 properties), StartExtractJobParams (7 properties), ExtractJobResponse (4 properties), CreateSessionProfile (3 properties). Each schema is shown below with its type and property counts.

StartExtractJobResponse
object
1 property 1 required
ErrorResponse
object
1 property
ISO639_1
string
ExtractJobResponse
object
4 properties 2 required
ProxyCountry
string
CreateSessionParams
object
37 properties
Device
string
CreateSessionProfile
object
3 properties
JobStatus
string
StartExtractJobParams
object
7 properties 1 required
JobStatusResponse
object
1 property 1 required
SessionRegion
string
Platform
string
ProxyState
string
Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.
OperatingSystem
string
ScreenConfig
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperbrowser-extract-api-openapi.yml Raw ↑

Other APIs Hyperbrowser publishes across the network.

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