{"openapi":"3.1.0","info":{"title":"Hyperbrowser (BYOK) API","version":"0.1.0","description":"Hyperbrowser (BYOK) lets an AI assistant read your own Hyperbrowser data through the Hyperbrowser API with a key you supply (API key). Read-only: 8 tools (list_sessions, get_session, list_profiles, get_profile, list_extensions, list_sandboxes, list_volumes, list_secrets). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-hyperbrowser.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-hyperbrowser/docs"},"termsOfService":"https://connectorbay.com/byok-hyperbrowser/terms"},"servers":[{"url":"https://byok-hyperbrowser.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-hyperbrowser/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_sessions":{"post":{"operationId":"list_sessions","summary":"List cloud browser sessions with status, start and end times and credits used. Filter by status. Use for \"Which Hyperbro","description":"List cloud browser sessions with status, start and end times and credits used. Filter by status. Use for \"Which Hyperbrowser sessions are active and how many credits have they used\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"status":{"anyOf":[{"enum":["active","closed","error","close-error"],"type":"string"},{"type":"null"}],"default":null,"description":"Only sessions with this status: active, closed, error or close-error.","title":"Status"}},"title":"list_sessionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_session":{"post":{"operationId":"get_session","summary":"Get one browser session by ID with status, times and credits used (connection tokens and endpoints are not returned). Us","description":"Get one browser session by ID with status, times and credits used (connection tokens and endpoints are not returned). Use for \"How long did this Hyperbrowser session run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Session ID, as returned by list_sessions.","maxLength":100,"title":"Id","type":"string"}},"required":["id"],"title":"get_sessionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_profiles":{"post":{"operationId":"list_profiles","summary":"List saved browser profiles (reusable browser state) with name and dates. Use for \"Which Hyperbrowser profiles do I have","description":"List saved browser profiles (reusable browser state) with name and dates. Use for \"Which Hyperbrowser profiles do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many profiles per page (default 10).","title":"Limit"},"name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only profiles whose name matches this text.","title":"Name"}},"title":"list_profilesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_profile":{"post":{"operationId":"get_profile","summary":"Get one browser profile by ID with its name and dates. Use for \"Show this Hyperbrowser profile\".","description":"Get one browser profile by ID with its name and dates. Use for \"Show this Hyperbrowser profile\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Profile ID, as returned by list_profiles.","maxLength":100,"title":"Id","type":"string"}},"required":["id"],"title":"get_profileArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_extensions":{"post":{"operationId":"list_extensions","summary":"List the browser extensions uploaded to the account with name and dates. Use for \"Which browser extensions have I upload","description":"List the browser extensions uploaded to the account with name and dates. Use for \"Which browser extensions have I uploaded to Hyperbrowser\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_extensionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_sandboxes":{"post":{"operationId":"list_sandboxes","summary":"List sandboxes (Linux or macOS cloud machines) with status, size, region, runtime and credits used. Filter by status, ti","description":"List sandboxes (Linux or macOS cloud machines) with status, size, region, runtime and credits used. Filter by status, time range or text. Use for \"Which Hyperbrowser sandboxes are running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items per page (default 10 for profiles and sandboxes, 20 for volumes and secrets).","title":"Limit"},"status":{"anyOf":[{"enum":["active","stopping","closed","close-error","error"],"type":"string"},{"type":"null"}],"default":null,"description":"Only sandboxes with this status: active, stopping, closed, close-error or error.","title":"Status"},"start":{"anyOf":[{"minimum":0,"type":"number"},{"type":"null"}],"default":null,"description":"Only sandboxes started after this time, in Unix milliseconds.","title":"Start"},"end":{"anyOf":[{"minimum":0,"type":"number"},{"type":"null"}],"default":null,"description":"Only sandboxes ended before this time, in Unix milliseconds.","title":"End"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match against sandboxes.","title":"Search"}},"title":"list_sandboxesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_volumes":{"post":{"operationId":"list_volumes","summary":"List storage volumes with name, size and transfer amount. Use for \"Which Hyperbrowser volumes do I have and how big are ","description":"List storage volumes with name, size and transfer amount. Use for \"Which Hyperbrowser volumes do I have and how big are they\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many volumes per page (default 20).","title":"Limit"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match against volume names.","title":"Search"}},"title":"list_volumesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_secrets":{"post":{"operationId":"list_secrets","summary":"List the names and types of stored secrets (values are never returned) with latest version and dates. Use for \"Which sec","description":"List the names and types of stored secrets (values are never returned) with latest version and dates. Use for \"Which secrets are stored in my Hyperbrowser account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many secrets per page (1 to 100, default 20).","title":"Limit"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match against secret names.","title":"Search"},"type":{"anyOf":[{"enum":["secret","totp","op_token"],"type":"string"},{"type":"null"}],"default":null,"description":"Only secrets of this type: secret, totp or op_token.","title":"Type"}},"title":"list_secretsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}