@runloop/api-client - v1.1.0
    Preparing search index...

    Class RunloopSDK

    Runloop SDK - The recommended way to interact with Runloop. Provides both low-level API access and high-level object-oriented interfaces.

    const runloop = new RunloopSDK(); // export RUNLOOP_API_KEY will automatically be used.
    const devbox = await runloop.devbox.create({ name: 'my-devbox' });
    const result = await devbox.cmd.exec('echo "Hello, World!"');
    console.log(result.exitCode);

    See the documentation for each Operations class for more details.

    This is useful when you need to access features not yet exposed through the high-level interfaces.

    See the RunloopAPI for the Runloop class for more details.

    const runloop = new RunloopSDK();
    const createResult = await runloop.api.secrets.create({ name: 'my-secret', value: 'my-secret-value' });
    console.log(createResult.name);
    Index

    Constructors

    constructor

    Properties

    api devbox blueprint snapshot storageObject agent

    Constructors

    Properties

    api: Runloop

    Low-level API client providing direct access to all Runloop API endpoints. Use this when you need fine-grained control or access to features not yet exposed through the high-level interfaces. Most users should prefer the specialized interfaces (devbox, blueprint, etc.) for a more convenient API.

    devbox: DevboxOps

    Devbox Operations - DevboxOps for creating and accessing Devbox class instances.

    Devboxes are isolated development environments running in Runloop's cloud - the core resource that provides you with a fully configured development environment. Use these operations to create new devboxes or get existing ones by ID.

    blueprint: BlueprintOps

    Blueprint Operations - BlueprintOps for creating and accessing Blueprint class instances.

    Blueprints are reusable templates that define the base configuration for devboxes, built from Dockerfiles. They can be used to create multiple devboxes with consistent environments. Use these operations to create new blueprints or get existing ones by ID.

    snapshot: SnapshotOps

    Snapshot Operations - SnapshotOps for creating and accessing Snapshot class instances.

    Snapshots are point-in-time copies of a devbox's disk state, allowing you to save the complete state of a devbox and restore it later or create new devboxes from saved states. Use these operations to list snapshots or get existing ones by ID.

    storageObject: StorageObjectOps

    Storage Object Operations - StorageObjectOps for creating and accessing StorageObject class instances.

    Storage objects are files stored in Runloop's object storage system. They can be uploaded, downloaded, and managed with metadata, useful for storing configuration files, data files, or any other content you need to persist or share between devboxes. Use these operations to create new storage objects or get existing ones by ID.

    agent: AgentOps

    Agent Operations - AgentOps for creating and accessing Agent class instances.

    Agents are registered AI agent entities that can be mounted into devboxes. Agents can be sourced from npm, pip, git repositories, or object storage, and provide reusable agent code that can be shared across multiple devboxes. Use these operations to create new agents or get existing ones by ID.

    Settings

    Member Visibility

    On This Page

    OperationsUse the HTTP API directly
    Constructors
    Properties