v48

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

Open a new browser tab

Create and open a new browser tab with the specified URL. This endpoint will navigate to the provided URL and return the new tab's information including its assigned id, loaded title, final URL (after any redirects), and favicon. The returned tab id can be used for future operations on this specific tab. The browser will attempt to load the page and will wait for the DOM content to be loaded before returning the response. If the URL is invalid or unreachable, an error will be returned.

post/boxes/{boxId}/browser/tabs

Path parameters

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

Box ID

Request body

urlstring required

The tab url

Example request

{
  "url": "https://www.google.com"
}

Response

Successfully opened new tab

idstring required

The tab id

titlestring required

The tab title

urlstring required

The tab url

faviconstring required

The tab favicon

activeboolean required

Whether the tab is the current active (frontmost) tab

loadingboolean required

Whether the tab is currently in a loading state.

The value is true while the browser is still navigating to the target URL or fetching sub-resources (i.e. document.readyState is not "complete"). It typically switches to false once the load event fires and all major network activity has settled.

Example response

{
  "id": "1",
  "title": "Google",
  "url": "https://www.google.com",
  "favicon": "https://www.google.com/favicon.ico",
  "active": true
}