modal
    Preparing search index...

    Class ModalClient

    The main client for interacting with Modal's cloud infrastructure.

    ModalClient provides access to all Modal services through service properties. Create a client instance and use its service properties to manage Apps, Functions, * Sandboxes, and other Modal resources.

    import { ModalClient } from "modal";

    const modal = new ModalClient();

    const app = await modal.apps.fromName("my-app");
    const image = modal.images.fromRegistry("python:3.13");
    const sandbox = await modal.sandboxes.create(app, image);
    Index

    Constructors

    constructor

    Properties

    apps cls functionCalls functions images profile proxies queues sandboxes secrets volumes

    Methods

    close environmentName imageBuilderVersion version

    Constructors

    Properties

    apps: AppService
    cls: ClsService
    functionCalls: FunctionCallService
    functions: FunctionService
    images: ImageService
    profile: Profile
    proxies: ProxyService
    queues: QueueService
    sandboxes: SandboxService
    secrets: SecretService
    volumes: VolumeService

    Methods

    • Parameters

      • Optionalenvironment: string

      Returns string

    • Parameters

      • Optionalversion: string

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods