List Devboxes. - 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

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

GET

devboxes

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() {
  // Automatically fetches more pages as needed.
  for await (const devboxView of client.devboxes.list()) {
    console.log(devboxView.id);
  }
}

main();

{
  "devboxes": [
    {
      "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"
      ]
    }
  ],
  "has_more": true,
  "total_count": 123,
  "remaining_count": 123
}

Authorizations

Authorization

string

header

required

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

Query Parameters

status

enum<string>

Filter by status

Available options:

provisioning,

initializing,

running,

suspending,

suspended,

resuming,

failure,

shutdown

limit

integer

The limit of items to return. Default is 20.

starting_after

string

Load the next page of data starting after the item with the given ID.

Response

200 - application/json

devboxes

object[]

required

List of devboxes matching filter.

A Devbox represents a virtual development environment. It is an isolated sandbox that can be given to agents and used to run arbitrary code such as AI generated code.

devboxes.id

string

required

The ID of the Devbox.

devboxes.status

enum<string>

required

The current status of the Devbox.

Available options:

provisioning,

initializing,

running,

suspending,

suspended,

resuming,

failure,

shutdown

devboxes.create_time_ms

integer

required

Creation time of the Devbox (Unix timestamp milliseconds).

devboxes.metadata

object

required

The user defined Devbox metadata.

devboxes.launch_parameters

object

required

The launch parameters used to create the Devbox.

devboxes.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

devboxes.name

string | null

The name of the Devbox.

devboxes.end_time_ms

integer | null

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

devboxes.blueprint_id

string | null

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

devboxes.snapshot_id

string | null

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

devboxes.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

devboxes.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

has_more

boolean

required

total_count

integer

required

remaining_count

integer

required

Was this page helpful?

The Devbox Object Create a Devbox.

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() {
  // Automatically fetches more pages as needed.
  for await (const devboxView of client.devboxes.list()) {
    console.log(devboxView.id);
  }
}

main();

{
  "devboxes": [
    {
      "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"
      ]
    }
  ],
  "has_more": true,
  "total_count": 123,
  "remaining_count": 123
}