Start a browser

Starts a browser as one of the caller's personas: on the key's provider, in a sandbox, or on a CDP endpoint the caller names (any Chrome with --remote-debugging-port). Answers 201 with the browser's id and its gateway CDP URL. A second start on an endpoint another browser already holds answers 409 endpoint_in_use; the body names the holder's id when it is yours.

post/browsers/start

Request

  • Base URL: https://oyabrowser.com
  • URL: https://oyabrowser.com/browsers/start
  • Auth: HTTP bearer

Request body

personastring

A persona id, or "auto" for a fresh one.

providerstring

cdp, oya-cloud, oya-selfhosted, or a vendor; defaults to the key's configured provider.

wsUrlstring

For provider cdp: the ws://, wss:// or http:// address of the debugging port.

namestring

A display name for the browser.

Response

The browser is ready to drive.

idstring
providerstring
personastring
statusstring
cdpUrlstring

The gateway CDP URL for this browser.

Changes

No recorded changes to this operation across all 1 revision of this API.