Sign in

v48

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-0297180624.8 KB
Browser

Open browser

Open the browser in the specified box. If the browser is already open, repeated calls will not open a new browser.

post/boxes/{boxId}/browser/open

Path parameters

boxIdstring required
Example:c9bdc193-b54b-4ddb-a035-5ac0c598d32d

Box ID

Request body

showControlsboolean

Whether to show the browser's minimize, maximize and close buttons. Default is true.

maximizeboolean

Whether to maximize the browser window.

sizestring

The window size, format: <width>x<height>. If not specified, the browser will open with the default size. If both maximize and size are specified, maximize will take precedence.

Example request

{
  "showControls": true,
  "size": "1024x768"
}

Response

Successfully opened the browser, return the CDP url

cdpUrlstring required

The CDP url. You can use this URL with CDP libraries like puppeteer/playwright/etc.

Example response

{
  "cdpUrl": "https://gbox.ai/api/v1/boxes/031df7cd-baa4-4d50-92ee-4ceaf04b0905/browser/connect/"
}