Worker reference

Worker is the supported runtime interface for one Devin Outposts outpost.

from modal_devin import Worker

Constructor

Worker(
    name: str,
    *,
    outpost_id: str,
    api_url: str = "https://api.beta.devinenterprise.com",
    settings: WorkerSettings | None = None,
)

string

required

Durable name for this deployment. It must contain a non-whitespace character.

string

required

Devin Outposts outpost ID.

string

default:"https://api.beta.devinenterprise.com"

Devin API base URL. Credentials, query strings, and fragments are rejected.

WorkerSettings | None

default:"None"

Validated runtime policy. Defaults to WorkerSettings().

`Worker.from_env()`

Worker.from_env(
    name: str,
    *,
    outpost_id: str,
    api_url: str = "https://api.beta.devinenterprise.com",
) -> Worker

Creates a worker whose runtime settings come from MODAL_DEVIN_* environment variables.

Properties

Property	Meaning
`name`	Original deployment name
`app_name`	Conventional generated Modal application name
`settings`	Validated `WorkerSettings` value
`session_function_timeout_seconds`	Minimum safe timeout for the session function

`controller_image()`

worker.controller_image(*, python_version: str = "3.12") -> modal.Image

Returns the image used by the generated scheduler. Most applications should leave it unchanged.

`base_image()`

worker.base_image(
    *,
    python_version: str = "3.12",
    install_ffmpeg: bool = True,
    install_chrome: bool = True,
) -> modal.Image

Returns the customizable image for new session workspaces. It includes the Devin CLI, common system tools, and /root/workspace.

`prepare_image()`

worker.prepare_image(image: modal.Image) -> modal.Image

Finishes a customized workspace image. Call it once after every custom image operation, and keep the generated application wiring unchanged.

`run_session()`

worker.run_session(
    session_id: str,
    *,
    app: modal.App,
    image: modal.Image,
    **sandbox_options,
) -> None

Runs one accepted session from workspace startup through worker execution, resumability, and cleanup.

string

required

Devin session ID supplied by the scheduler.

modal.App

required

Deployed Modal application.

modal.Image

required

Prepared workspace image for a new session.

Additional supported keywords follow modal.Sandbox.create, including resources and region. Positional commands and the managed timeout, workdir, and readiness_probe options are rejected. The containing function must receive the configured Devin credential.

`dispatch_pending_sessions()`

worker.dispatch_pending_sessions(
    spawn_session: Callable[[str], object],
) -> None

Finds queued sessions for the configured outpost and starts Modal invocations. Pass the generated session function’s asynchronous spawn method:

worker.dispatch_pending_sessions(session.spawn)

The scheduler function must receive the configured Devin credential and retain the generated single-container limit.

Tutorials

How-to guides

Concepts

Reference

Constructor

`Worker.from_env()`

Properties

`controller_image()`

`base_image()`

`prepare_image()`

`run_session()`

`dispatch_pending_sessions()`

​Constructor

​Worker.from_env()

​Properties

​controller_image()

​base_image()

​prepare_image()

​run_session()

​dispatch_pending_sessions()

Constructor

`Worker.from_env()`

Properties

`controller_image()`

`base_image()`

`prepare_image()`

`run_session()`

`dispatch_pending_sessions()`