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

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

blueprints

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 blueprintView of client.blueprints.list()) {
    console.log(blueprintView.id);
  }
}

main();

{
  "blueprints": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "provisioning",
      "state": "created",
      "create_time_ms": 123,
      "parameters": {
        "name": "<string>",
        "dockerfile": "<string>",
        "system_setup_commands": [
          "<string>"
        ],
        "code_mounts": [
          {
            "repo_name": "<string>",
            "repo_owner": "<string>",
            "install_command": "<string>",
            "token": "<string>"
          }
        ],
        "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
        },
        "file_mounts": {}
      },
      "failure_reason": "out_of_memory"
    }
  ],
  "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

name

string

Filter by name

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

blueprints

object[]

required

List of blueprints matching filter.

Blueprints are ways to create customized starting points for Devboxes. They allow you to define custom starting points for Devboxes such that environment set up can be cached to improve Devbox boot times.

blueprints.id

string

required

The id of the Blueprint.

blueprints.name

string

required

The name of the Blueprint.

blueprints.status

enum<string>

required

The status of the Blueprint build.

Available options:

provisioning,

building,

failed,

build_complete

blueprints.state

enum<string>

required

The state of the Blueprint.

Available options:

created,

deleted

blueprints.create_time_ms

integer

required

Creation time of the Blueprint (Unix timestamp milliseconds).

blueprints.parameters

object

required

The parameters used to create Blueprint.

blueprints.parameters.name

string

required

Name of the Blueprint.

blueprints.parameters.dockerfile

string | null

Dockerfile contents to be used to build the Blueprint.

blueprints.parameters.system_setup_commands

string[] | null

A list of commands to run to set up your system.

blueprints.parameters.code_mounts

object[] | null

A list of code mounts to be included in the Blueprint.

blueprints.parameters.launch_parameters

object

Parameters to configure your Devbox at launch time.

blueprints.parameters.file_mounts

object | null

(Optional) Map of paths and file contents to write before setup..

blueprints.failure_reason

enum<string>

The failure reason if the Blueprint build failed, if any.

Available options:

out_of_memory,

out_of_disk,

build_failed

has_more

boolean

required

total_count

integer

required

remaining_count

integer

required

Was this page helpful?

The Blueprint Object Create and build a Blueprint.

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 blueprintView of client.blueprints.list()) {
    console.log(blueprintView.id);
  }
}

main();

{
  "blueprints": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "provisioning",
      "state": "created",
      "create_time_ms": 123,
      "parameters": {
        "name": "<string>",
        "dockerfile": "<string>",
        "system_setup_commands": [
          "<string>"
        ],
        "code_mounts": [
          {
            "repo_name": "<string>",
            "repo_owner": "<string>",
            "install_command": "<string>",
            "token": "<string>"
          }
        ],
        "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
        },
        "file_mounts": {}
      },
      "failure_reason": "out_of_memory"
    }
  ],
  "has_more": true,
  "total_count": 123,
  "remaining_count": 123
}