Create a Browser. - Runloop AI Docs

API Reference

Introduction

Devbox

The Devbox Object
Devbox Lifecycle
Devbox File Tools
Devbox Shell Tools
Devbox Network Tools
Devbox Persistence Tools
Devbox Observability Tools
Devbox Add-ons
- Browser
  - POST
    Create a Browser.
  - GET
    Get Browser Details.
- Computer

Blueprint

The Blueprint Object
Blueprint Lifecycle
Blueprint Observability

Repository

The Repository Object
Repository Lifecycle

Code Scenario

Code Scenario Lifecycle
Scenarios Runs
Custom Scenario Scorer
Public Scenarios

Benchmark

Benchmark Lifecycle
Benchmark Runs
Public Benchmarks

POST

devboxes

browsers

import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const browserView = await client.devboxes.browsers.create();

  console.log(browserView.connection_url);
}

main();

{
  "devbox": {
    "id": "<string>",
    "name": "<string>",
    "status": "provisioning",
    "create_time_ms": 123,
    "end_time_ms": 123,
    "blueprint_id": "<string>",
    "snapshot_id": "<string>",
    "metadata": {},
    "failure_reason": "out_of_memory",
    "shutdown_reason": "api_shutdown",
    "launch_parameters": {
      "launch_commands": [
        "<string>"
      ],
      "resource_size_request": "X_SMALL",
      "keep_alive_time_seconds": 123,
      "available_ports": [
        123
      ],
      "after_idle": {
        "idle_time_seconds": 123,
        "on_idle": "shutdown"
      },
      "custom_cpu_cores": 123,
      "custom_gb_memory": 123
    },
    "capabilities": [
      "unknown"
    ]
  },
  "connection_url": "<string>",
  "live_view_url": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string | null

The name to use for the created Devbox with a Browser.

Response

200 - application/json

A Browser represents a managed implementation of a browser like Chromiumon top of Devboxes. It includes the tunnel to the live screen and the underlying DevboxView.

devbox

object

required

The underlying devbox the browser setup is running on.

devbox.id

string

required

The ID of the Devbox.

devbox.status

enum<string>

required

The current status of the Devbox.

Available options:

provisioning,

initializing,

running,

suspending,

suspended,

resuming,

failure,

shutdown

devbox.create_time_ms

integer

required

Creation time of the Devbox (Unix timestamp milliseconds).

devbox.metadata

object

required

The user defined Devbox metadata.

devbox.launch_parameters

object

required

The launch parameters used to create the Devbox.

devbox.capabilities

enum<string>[]

required

A list of capability groups this devbox has access to. This allows devboxes to be compatible with certain tools sets like computer usage APIs.

Available options:

unknown,

computer_usage,

browser_usage,

language_server

devbox.name

string | null

The name of the Devbox.

devbox.end_time_ms

integer | null

The time the Devbox finished execution (Unix timestamp milliseconds). Present if the Devbox is in a terminal state.

devbox.blueprint_id

string | null

The Blueprint ID used in creation of the Devbox, if the devbox was created from a Blueprint.

devbox.snapshot_id

string | null

The Snapshot ID used in creation of the Devbox, if the devbox was created from a Snapshot.

devbox.failure_reason

enum<string>

The failure reason if the Devbox failed, if the Devbox has a 'failure' status.

Available options:

out_of_memory,

out_of_disk,

execution_failed

devbox.shutdown_reason

enum<string>

The shutdown reason if the Devbox shutdown, if the Devbox has a 'shutdown' status.

Available options:

api_shutdown,

keep_alive_timeout,

entrypoint_exit,

idle,

lambda_lifecycle

connection_url

string

required

The url to enable remote connection from browser automation tools like playwright.

live_view_url

string

required

The url to view the browser window and enable user interactions via their own browser. You can control the interactivity of the browser by adding or removing 'view_only' query parameter. view_only=1 will allow interaction and view_only=0 will disable interaction.

Was this page helpful?

Live Tail Devbox Logs.Get Browser Details.

import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const browserView = await client.devboxes.browsers.create();

  console.log(browserView.connection_url);
}

main();

{
  "devbox": {
    "id": "<string>",
    "name": "<string>",
    "status": "provisioning",
    "create_time_ms": 123,
    "end_time_ms": 123,
    "blueprint_id": "<string>",
    "snapshot_id": "<string>",
    "metadata": {},
    "failure_reason": "out_of_memory",
    "shutdown_reason": "api_shutdown",
    "launch_parameters": {
      "launch_commands": [
        "<string>"
      ],
      "resource_size_request": "X_SMALL",
      "keep_alive_time_seconds": 123,
      "available_ports": [
        123
      ],
      "after_idle": {
        "idle_time_seconds": 123,
        "on_idle": "shutdown"
      },
      "custom_cpu_cores": 123,
      "custom_gb_memory": 123
    },
    "capabilities": [
      "unknown"
    ]
  },
  "connection_url": "<string>",
  "live_view_url": "<string>"
}