Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox.

class BetaSelfHostedWorkHeartbeatResponse { last_heartbeat, lease_extended, state, 2 more }

Response after recording a heartbeat for a work item.

last_heartbeat: String

RFC 3339 timestamp of the actual heartbeat from DB

lease_extended: bool

Whether the heartbeat succeeded in extending the lease

state: :queued | :starting | :active | 2 more

Current state of the work item (active/stopping/stopped)

One of the following:

:queued

:starting

:active

:stopping

:stopped

ttl_seconds: Integer

Effective TTL applied to the lease

type: :work_heartbeat

The type of response

class BetaSelfHostedWorkListResponse { data, next_page }

Response when listing work items with cursor-based pagination.

class BetaSelfHostedWorkQueueStats { depth, oldest_queued_at, pending, 2 more }

Statistics about the work queue for an environment.

Uses Redis Stream consumer group metrics for O(1) queries.

depth: Integer

Number of work items waiting to be picked up (lag from consumer group)

oldest_queued_at: String

RFC 3339 timestamp of oldest item in the work stream (includes both queued and pending items), null if stream empty

pending: Integer

Number of work items being processed (polled but not acknowledged)

type: :work_queue_stats

The type of object

workers_polling: Integer

Number of workers that have polled for work in the last 30 seconds. Requires worker_id to be sent with poll requests.

class BetaSelfHostedWorkStopRequest { force }

Request to stop a work item.

force: bool

If true, immediately stop work without graceful shutdown

class BetaSelfHostedWorkUpdateRequest { metadata }

Request to update work item metadata.

metadata: Hash[Symbol, String]

Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve existing metadata.

class BetaSessionWorkData { id, type }

Work data for session work items.

This resource type is used when work represents a session that needs to be executed in a self-hosted environment.

id: String

Session identifier (e.g., 'session_...')

type: :session

Type of work data