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

The Sandboxes API from Hyperbrowser — 9 operation(s) for sandboxes.

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

Tagged areas include Sandbox. The published artifact set on APIs.io includes an OpenAPI specification.

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

9 operations 9 paths 29 schemas 2 GET5 POST2 PUT

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 Sandboxes 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 9

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

Sandboxes 9
POST
/api/sandbox
Create new sandbox
postApiSandbox body → 200
GET
/api/sandbox/{id}
Get sandbox by ID
getApiSandboxById 1 param → 200
GET
/api/sandboxes
Get list of sandboxes
getApiSandboxes 6 params → 200
PUT
/api/sandbox/{id}/stop
Stop a sandbox
putApiSandboxByIdStop 1 param → 200
POST
/api/sandbox/{id}/expose
Expose a sandbox port
postApiSandboxByIdExpose 1 param body → 200
POST
/api/sandbox/{id}/unexpose
Remove an exposed sandbox port
postApiSandboxByIdUnexpose 1 param body → 200
POST
/api/sandbox/{id}/snapshot
Create a sandbox memory snapshot
postApiSandboxByIdSnapshot 1 param body → 200
PUT
/api/sandbox/{id}/network
Update sandbox network policy
putApiSandboxByIdNetwork 1 param body → 200
POST
/api/sandbox/{id}/processes
Start a sandbox process with secrets
startSandboxSecretProcess 1 param body → 200400401403404409422429

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are SandboxDetail (25 properties), Sandbox (23 properties), CreateSandboxParams (20 properties), SandboxSecretBinding (9 properties). Each schema is shown below with its type and property counts.

SandboxExposePortParams
object
2 properties 1 required
SecretReference
object
2 properties 1 required
SecretSource
object
Where a variable came from: the request's vault, its secrets, or its onePassword.
2 properties 1 required
SandboxRuntimeTarget
object
Connection details for the sandbox runtime API (process execution, files, terminals).
3 properties 3 required
SandboxListResponse
object
4 properties 4 required
SandboxMemorySnapshotResponse
object
7 properties 4 required
StartSandboxSecretProcessParams
object
Provide at least one of secrets, vault and onePassword.
8 properties 1 required
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…
SecretErrorResponse
object
HTTP failure. Secret errors include code and message; request validation errors include only message; API key scope errors include error, message and requiredS…
6 properties
SandboxNetworkPolicyPatch
object
Partial network policy update. Omitted fields keep their current values.
3 properties
SandboxExposedPort
object
5 properties 3 required
SandboxSecretProcess
object
The started process. Its environment is never returned.
8 properties 5 required
SandboxDetail
object
25 properties 5 required
SecretReferences
object
Environment variables to set from secrets, keyed by variable name (letters, digits and , not starting with a digit), at most 32. {} is the same as none. An opt…
SandboxMemorySnapshotParams
object
1 property
CreateSandboxParams
object
Provide exactly one start source: imageName (with optional imageId), snapshotName (Linux, with optional snapshotId), or diskId (macOS). macOS is in beta; conta…
20 properties
SandboxNetworkPolicy
object
Effective outbound network policy for a sandbox.
3 properties 3 required
SandboxSecretBinding
object
One environment variable a process received, never its value. A stored secret has name, secretId and version. A 1Password variable (source.type onePassword) ha…
9 properties 2 required
OnePasswordField
object
A field of an item in the request's 1Password vault (onePassword.vault), read as op:// / /[ /] . The whole reference can be at most 512 bytes of UTF-8.
3 properties 2 required
SandboxUnexposePortResponse
object
2 properties 2 required
SandboxNetworkUpdateResponse
object
1 property 1 required
SandboxStatus
string
Current sandbox lifecycle status. macOS can report stopping while disk changes are being saved and the VM is being released.
BasicResponse
object
1 property 1 required
SandboxVolumeMount
object
A volume mount attached at sandbox launch. Keys of the mounts map are absolute mount paths inside the sandbox.
3 properties 1 required
CreateSandboxResponse
StartSandboxSecretProcessResponse
object
2 properties 2 required
SandboxUnexposePortParams
object
1 property 1 required
OnePasswordSource
object
Environment variables read from fields of one 1Password vault when the process starts, signed in with a 1Password service account token stored as an optoken se…
3 properties 3 required
Sandbox
object
23 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperbrowser-sandboxes-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
Hyperbrowser Images API
Where this information came from

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