Ruby SDK

rubyrequire "withruntime"runtime = WithRuntime::Client.newsbx = runtime.sandboxes.createbegin  sbx.files.write("/workspace/invoice.py", "print(sum([125, 250, 375]))\n")  puts sbx.exec("python3 /workspace/invoice.py", check: true).stdoutensure  sbx.stopend

create returns once the sandbox is running. With no arguments, you get the free usage while it lasts, the default region, and 2 vCPU, 4 GiB of memory and a 4 GiB disk. The sandbox runs while it works and pauses itself when idle. It has no time limit unless you set one with timeout_seconds: (60 to 86,400). The free usage is spent first, then prepaid credit. funding: is accepted and ignored. Every field is optional, in snake_case:

rubyrequire "withruntime"runtime = WithRuntime::Client.newsbx = runtime.sandboxes.create(  name: "tests-42",  labels: { team: "search", job: "42" },  vcpu: 2,  memory_mib: 4096,  disk_mib: 8192,  timeout_seconds: 900,  on_lease_end: "stop",  network: { internet: true, allow: ["rubygems.org", "*.githubusercontent.com"] })puts sbx.id, sbx.info.funding, sbx.info.ends_atsbx.stop

A response can be read by snake_case name (sbx.info.memory_mib) or by the API's own key (sbx.info["memoryMiB"]). A field newer than the SDK is always there. A string key in a request ("newField" => 1) is sent as written.

A string runs under bash -c. An array runs the program directly, with no shell. Use an array for untrusted arguments.

rubyrequire "withruntime"runtime = WithRuntime::Client.newsbx = runtime.sandboxes.createsbx.exec("mkdir -p app && echo 'print(1 + 1)' > app/main.py")run = sbx.exec(["python3", "main.py"], cwd: "/workspace/app", env: { API_TOKEN: ENV.fetch("API_TOKEN", "") }, timeout: 120)warn run.stderr unless run.exit_code.zero?print run.stdoutsbx.exec("for i in 1 2 3; do echo line $i; sleep 1; done", on_stdout: ->(text) { print text })sbx.exec_stream("node --version") do |event|  print event["data"] if event["type"] == "stdout"endsbx.stop

• env: passes secrets to a command. Runtime never echoes them back. Never put a secret in the command line.
• stdin: gives the command input, then closes it.
• user: "root" runs the command as root, with no sudo in front, keeping its env: and PATH; HOME is /root. spawn and terminal take it too.
• The default timeout is 60 seconds; the maximum is a day. A timeout is a result (timed_out is true, with the output so far), not an exception.
• check: true raises WithRuntime::CommandError, with the exit code and output, on a non-zero exit or a timeout.
• With on_stdout:, on_stderr:, or a timeout over a minute, the command streams. The result keeps everything it printed. When the server ends a long stream, the stream resumes by itself. No output is dropped.

rubyrequire "withruntime"runtime = WithRuntime::Client.newsbx = runtime.sandboxes.createserver = sbx.spawn("python3 -m http.server 8000", cwd: "/workspace")repl = sbx.spawn(["python3", "-i", "-q"], pipe_stdin: true)repl.write("print(21 * 2)\n", eof: true)print repl.wait.stdoutsbx.processes.each { |process| puts "#{process.id} #{process.state} #{process.command}" }server.kill("SIGTERM")sbx.stop

A process outlives your connection. Get it back with sbx.process(id). write tracks input offsets, so a retried write is never typed twice.

rubyrequire "withruntime"runtime = WithRuntime::Client.newsbx = runtime.sandboxes.createsbx.files.write("/workspace/data/input.csv", "a,b\n1,2\n")print sbx.files.read_text("/workspace/data/input.csv")sbx.files.list("/workspace", depth: 2).each { |entry| puts "#{entry.type} #{entry.size} #{entry.path}" }sbx.files.mkdir("/workspace/out")sbx.files.rename("/workspace/data/input.csv", "/workspace/out/input.csv")sbx.files.upload("./lib", "/workspace/project/lib")sbx.files.download("/workspace/out", "./out")sbx.stop

write creates parent directories and replaces the file atomically. A file over 1 MiB goes in parallel chunks, each checked by SHA-256. stat returns nil for a path that does not exist. upload and download move a whole directory as one gzipped archive. Pass mode: 0o755 to write an executable. Pass mode: 0 for no permission bits. chmod(path, mode) changes an existing file. A caller-supplied idempotency_key: also makes a complete large-file write safe to repeat. Each upload phase keeps its own stable key. On an older guest, setting a mode also needs the exec grant for its chmod fallback.

Links

A link is a secret URL that anyone can open, with no API key. A GET downloads the file. Range requests work, so videos play and downloads resume. A PUT with the raw body uploads the file atomically. A link expires in 1 hour by default, and at most 7 days. revoke_links ends every link made for the sandbox. Revoking the key that made a link also ends its links.

rubyrequire "withruntime"runtime = WithRuntime::Client.newsbx = runtime.sandboxes.createsbx.files.write("/workspace/report.csv", "a,b\n1,2\n")down = sbx.files.download_url("/workspace/report.csv", filename: "report.csv", expires_in_seconds: 600)up = sbx.files.upload_url("/workspace/incoming.bin", max_bytes: 10 * 1024 * 1024)puts down["url"], down["expiresAt"], up["url"]sbx.files.revoke_linkssbx.stop

rubyrequire "withruntime"runtime = WithRuntime::Client.newsbx = runtime.sandboxes.createsbx.pause # memory and files are kept; compute billing stopsagain = runtime.sandboxes.get(sbx.id)again.wake(timeout_seconds: 1200)again.extend_lease(600)copies = again.fork(count: 2)copies.each(&:stop)snapshot = again.snapshot(name: "ready", retention_days: 7)runtime.sandboxes.create(snapshot: snapshot.id).stopruntime.snapshots.delete(snapshot.id)again.stop

A fork copies a sandbox as it is now, with its files, memory and running processes. It runs on its server while that server has room, and on another server when it is full. See JavaScript for what forks and snapshots keep and how they are billed. If a copy fails, the error's details["startedSandboxIds"] names the copies that did start. Ruby's own extend is taken, so a time limit moves on with extend_lease(seconds). A sandbox with no time limit has nothing to move. sbx.keep_alive moves the time limit on from your process until stop. runtime.sandboxes.get_or_create(name, **fields) returns the sandbox with that name, woken or restarted, or creates it.

rubyrequire "withruntime"runtime = WithRuntime::Client.newsbx = runtime.sandboxes.createsbx.spawn("python3 -m http.server 3000")preview = sbx.previews.create(3000)puts preview.url, preview.token # send the token as x-runtime-preview-tokensbx.stop

A preview is private by default. visibility: "public" shares it with anyone who has the address. It works on a paid sandbox only. A sandbox without credit keeps its previews private. Addresses are under runtimehost.com.

rubyrequire "withruntime"runtime = WithRuntime::Client.newimage = runtime.images.build(name: "data", recipe: { pip: ["pandas"], apt: ["jq"] }) { |line| puts line.text }volume = runtime.volumes.create(size_mib: 10_240, name: "cache")sbx = runtime.sandboxes.create(image: image.id, volumes: [{ volume_id: volume.id, path: "/data" }])print sbx.exec("python3 -c 'import pandas; print(pandas.__version__)'").stdoutcell = sbx.interpreter.run("import math\nround(math.pi * 2, 3)")puts cell.results.first.data["text/plain"]sbx.network.set(internet: true, allow: ["pypi.org", "*.pythonhosted.org"])sbx.stopsecret = runtime.secrets.set("OPENAI_API_KEY", value: "sk-...", hosts: ["api.openai.com"])puts secret.placeholder # what sandboxes see in $OPENAI_API_KEY

images.build waits until the image is ready. It raises with code image_failed when the build fails. images.create queues the build and returns. A Dockerfile build takes dockerfile: and context_dir:, the folder docker build would read, with its .dockerignore. Only the parts the server does not have yet are uploaded. See custom images. A volume lives on one server. Volume backups can restore its data onto another host. sbx.desktop drives a Linux desktop in the sandbox.

rubyrequire "withruntime"runtime = WithRuntime::Client.newsbx = runtime.sandboxes.createruntime.domains.add(hostname: "app.example.org", sandbox_id: sbx.id, port: 8080)p runtime.domains.get("app.example.org") # DNS records to install, then verifyruntime.domains.verify("app.example.org")port = runtime.ports.open(sandbox_id: sbx.id, port: 5432)p portruntime.ports.close(port.id)runtime.domains.remove("app.example.org")sbx.stop

runtime.ips.reserve(family: 4) reserves a dedicated address. list and release(id) manage it. The SDK keeps returned funding fields and integer money as the API sends them. runtime.networks.wireguard manages the account's WireGuard network with create, get, delete, add_peer, rotate_peer and remove_peer. Save a generated peer's config securely, even when config_ready is false. Its private key is returned once. Calls that generate a private key are not retried automatically. runtime.sso.get reads the organization's SSO state.

rubyrequire "withruntime"runtime = WithRuntime::Client.newvolume = runtime.volumes.create(size_mib: 1024)backup = runtime.volumes.backup(volume.id, name: "before-import", retention_days: 7)runtime.volumes.set_backup_policy(volume.id, daily: true, retention_days: 7)runtime.volumes.set_backup_policy(volume.id, every_minutes: 60, keep: { hourly: 24, daily: 7 })runtime.volumes.set_backup_policy(volume.id, no_schedule: true)restored = runtime.volumes.restore(backup.id, name: "restored")p runtime.volumes.backups(volume_id: volume.id).dataruntime.volumes.delete_backup(backup.id)runtime.volumes.delete(restored.id)runtime.volumes.delete(volume.id)

sbx.mounts.add(provider: "s3", bucket: "data", path: "/data", secret: "S3_KEY") mounts an object store. list and remove(path) manage mounts. The named secret stays on Runtime.

sbx.desktop.recordings.start(fps: 10) returns a recording. Use get(id), list, stop(id), download(id) for MP4 bytes, and delete(id) to manage it.

rubyrequire "withruntime"runtime = WithRuntime::Client.newsbx = runtime.sandboxes.createwatch = sbx.files.watch("/workspace", recursive: true)begin  watch.events.each { |event| puts "#{event.k}: #{event.path}" }ensure  watch.stop  sbx.stopend

The reader follows continuation messages and keeps watch.cursor. Overflow and lost-event notices reach your block. watch.close cancels only the active reader. Another thread can call it while HTTP headers, a body or a retry delay is pending. watch.stop also removes the watch in the guest and prevents new readers. A paused sandbox ends the current stream.

rubyrequire "withruntime"runtime = WithRuntime::Client.newsbx = runtime.sandboxes.get("your-sandbox-id")terminal = sbx.terminal(cols: 100, rows: 30)begin  terminal.write("printf 'hello\n'\n")  print terminal.read  terminal.resize(cols: 120, rows: 40)ensure  terminal.closeendforward = sbx.port_forward(8080)begin  puts "Local server: http://#{forward.host}:#{forward.port}"ensure  forward.closeend

A terminal exposes read, write, resize, process_id, exit_code and close. sbx.open_tunnel shares one authenticated connection across connect(port) and ssh(public_key) streams. Each stream supports read, write, close_write and close. After close_write, the stream can still read the response. port_forward binds to 127.0.0.1 and a free port by default. Pass host: and local_port: to choose them. Closing it releases its listener and active connections.

Read responses while you write large requests. An unread stream buffers at most 1 MiB. Overflow closes that stream with tunnel_receive_overflow. Other streams stay usable. Closing a terminal or tunnel wakes blocked readers and writers. WebSockets use the same API key and origin. They support an HTTP CONNECT proxy and verify TLS certificates.

rubyrequire "withruntime"runtime = WithRuntime::Client.newhook = runtime.webhooks.create(url: "https://example.com/hooks/runtime")secret = hook.secret # shown once; keep it# In your endpoint, with the raw body and the Runtime-Signature header:begin  event = WithRuntime::Webhooks.verify("{}", "t=0,v1=0", secret)  puts event.typerescue WithRuntime::WebhookVerificationError => e  puts "refused: #{e.message}"endruntime.events.list(type: "sandbox.stopped").each { |event| puts "#{event.created_at} #{event.type}" }

sbx.metrics(range: "15m") returns the sandbox's measured CPU and memory, and runtime.otel.create(endpoint: ...) pushes events and metrics to an OpenTelemetry endpoint. See metrics and webhooks.

rubyrequire "withruntime"runtime = WithRuntime::Client.newbegin  runtime.sandboxes.get("00000000-0000-4000-8000-000000000000")rescue WithRuntime::NotFoundError  puts "no such sandbox"rescue WithRuntime::Error => e  puts e.code, e.hint, e.request_idend

Every error is a WithRuntime::Error with code, message, hint, request_id, status and details. Its subclasses are AuthenticationError, PermissionDeniedError, NotFoundError, ConflictError, InvalidRequestError, RateLimitError, ServiceUnavailableError, ConnectionError and CommandError. They are the same classes as in the JavaScript, Python, Go and Java SDKs. no_capacity raises ServiceUnavailableError. no_credit_running_limit, and a quota_exceeded on what runs at the same time, raise RateLimitError. A quota_exceeded on what is kept raises ConflictError.

Every write carries an idempotency key. The client makes it for you and keeps it across its own retries. Transport failures, and every response that says retryable: true, are retried after its Retry-After. Retries stop at the maximum number of retries. Each retry uses the same key, so a retry never makes two sandboxes or runs a command twice. A wait over 60 seconds is not slept on. The error returns immediately, with retryAfterMs. A response that ran nothing (guest_busy, busy, rate_limited, sandbox_starting) is sent again until the call's deadline. Without a deadline, it is sent again for five minutes, past the maximum. retryable? says whether trying the same call again may work.

A create, wake or restart waits for room. When all four slots without credit are taken (no_credit_running_limit), the account is at its limit (quota_exceeded), or the region is full (no_capacity), sandboxes.create waits and sends the same request again, for up to two minutes. Pass wait_for_capacity: (seconds) to the client or to one create, wake or restart. Zero fails immediately, as in sandbox.wake(wait_for_capacity: 0). A sandbox stays on its server, so a wake or restart refused with no_capacity is sent again with the same idempotency key until room frees. A fork waits the same way when no server has room for a copy, as in sandbox.fork(wait_for_capacity: 0) to fail immediately.

An owner, admin or developer can make a read-only key and set a daily spending limit on a key at API keys. runtime.limits.get reads both. Past the limit, a create, wake or extension raises with code spending_limit_reached, and it is not retried.

rubyrequire "withruntime"runtime = WithRuntime::Client.new(  api_key: ENV.fetch("MY_RUNTIME_KEY"),  timeout: 120,  max_retries: 4,  wait_for_capacity: 600)puts runtime.me.org_idp runtime.request("GET", "/v1/volumes") # any endpoint, same rules

• RUNTIME_API_URL points the client at another API origin, as base_url: does.
• Code inside a Runtime sandbox calls Runtime's API at http://runtime.internal (Runtime's API from inside a sandbox).
• The client is safe to share between threads. It keeps its connections open and holds at most 32 calls in flight (max_connections:).
• It honours HTTPS_PROXY and NO_PROXY.
• Money is integer microdollars: 1,000,000 is one US dollar. runtime.usage.available is the account's balance as an exact decimal string.
• runtime.usage_export(since:, until:, cursor:) reads one page of settled usage over a UTC range, with its server CSV. Follow next_cursor until it is nil. final_through is the time before which no more charges will settle. A row's final is true once its resource is deleted and can be charged nothing more (export settled usage).