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

Start, stop, and monitor agentic browser tasks across HyperAgent, Browser-Use, Claude Computer Use, Gemini Computer Use, and OpenAI's CUA. Each task runs inside a stealth Hyperbrowser session with live-view URL, proxy support, and CAPTCHA solving.

Hyperbrowser Agents 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 Agents, Computer Use, HyperAgent, Browser-Use, and Claude. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 JSON Schema.

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

20 operations 20 paths 36 schemas 10 GET5 POST5 PUT

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 Agents 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 20

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

Agents 20
POST
/api/task/hyper-agent
Start a HyperAgent Task
post-api-task-hyper-agent body → 200500
GET
/api/task/hyper-agent/{id}
Get HyperAgent Task Status and Results
get-api-task-hyper-agent-id 1 param → 200404500
PUT
/api/task/hyper-agent/{id}/stop
Stop a HyperAgent Task
put-api-task-hyper-agent-id-stop 1 param → 200
GET
/api/task/hyper-agent/{id}/status
Get HyperAgent Task Status
get-api-task-hyper-agent-id-status 1 param → 200404500
POST
/api/task/browser-use
Start a Browser Use Task
post-api-task-browser-use body → 200500
GET
/api/task/browser-use/{id}
Get Browser Use Task Status and Results
get-api-task-browser-use-id 1 param → 200404500
PUT
/api/task/browser-use/{id}/stop
Stop a Browser Use Task
put-api-task-browser-use-id-stop 1 param → 200
GET
/api/task/browser-use/{id}/status
Get Browser Use Task Status
get-api-task-browser-use-id-status 1 param → 200404500
POST
/api/task/claude-computer-use
Start a Claude Computer Use Task
post-api-task-claude-computer-use body → 200500
GET
/api/task/claude-computer-use/{id}
Get Claude Computer Use Task Status and Results
get-api-task-claude-computer-use-id 1 param → 200404500
PUT
/api/task/claude-computer-use/{id}/stop
Stop a Claude Computer Use Task
put-api-task-claude-computer-use-id-stop 1 param → 200
GET
/api/task/claude-computer-use/{id}/status
Get Claude Computer Use Task Status
get-api-task-claude-computer-use-id-status 1 param → 200404500
POST
/api/task/gemini-computer-use
Start a Gemini Computer Use Task
post-api-task-gemini-computer-use body → 200500
GET
/api/task/gemini-computer-use/{id}
Get Gemini Computer Use Task Status and Results
get-api-task-gemini-computer-use-id 1 param → 200404500
PUT
/api/task/gemini-computer-use/{id}/stop
Stop a Gemini Computer Use Task
put-api-task-gemini-computer-use-id-stop 1 param → 200
GET
/api/task/gemini-computer-use/{id}/status
Get Gemini Computer Use Task Status
get-api-task-gemini-computer-use-id-status 1 param → 200404500
POST
/api/task/cua
Start a CUA Task
post-api-task-cua body → 200500
GET
/api/task/cua/{id}
Get CUA Task Status and Results
get-api-task-cua-id 1 param → 200404500
PUT
/api/task/cua/{id}/stop
Stop a CUA Task
put-api-task-cua-id-stop 1 param → 200
GET
/api/task/cua/{id}/status
Get CUA Task Status
get-api-task-cua-id-status 1 param → 200404500

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are CreateSessionParams (37 properties), StartBrowserUseTaskParams (21 properties), StartCuaTaskParams (10 properties), StartGeminiComputerUseTaskParams (10 properties). Each schema is shown below with its type and property counts.

GeminiComputerUseTaskResponse
object
5 properties 2 required
StartGeminiComputerUseTaskParams
object
10 properties 1 required
StartHyperAgentTaskParams
object
9 properties 1 required
ClaudeComputerUseLlm
string
StartClaudeComputerUseTaskParams
object
10 properties 1 required
HyperAgentTaskResponse
object
5 properties 2 required
StartCuaTaskParams
object
10 properties 1 required
JobStatus
string
StartBrowserUseTaskResponse
object
2 properties 1 required
CuaTaskResponse
object
5 properties 2 required
BrowserUseVersion
string
BrowserUseTaskResponse
object
5 properties 2 required
ProxyCountry
string
BrowserUseLlm
string
Device
string
CreateSessionProfile
object
3 properties
SessionRegion
string
ProxyState
string
Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.
CuaLlm
string
ScreenConfig
object
2 properties
StartCuaTaskResponse
object
2 properties 1 required
StartGeminiComputerUseTaskResponse
object
2 properties 1 required
ISO639_1
string
StartBrowserUseTaskParams
object
21 properties 1 required
StartClaudeComputerUseTaskResponse
object
2 properties 1 required
GeminiComputerUseLlm
string
HyperAgentLlm
string
CreateSessionParams
object
37 properties
JobStatusResponse
object
1 property 1 required
BasicResponse
object
1 property
Platform
string
OperatingSystem
string
HyperAgentVersion
string
ErrorResponse
object
1 property
ClaudeComputerUseTaskResponse
object
5 properties 2 required
StartHyperAgentTaskResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperbrowser-agents-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 Extensions API
Hyperbrowser Web API
Hyperbrowser Profile API
Hyperbrowser Session API
Hyperbrowser Task API
Hyperbrowser X402 API