boxie

Developer portal

Build with Boxie.

A typed REST API and official CLI for persistent Ubuntu workspaces. Start with the contract, keep every operation bounded, and treat compute as a billable resource.

Machine contract

Start from OpenAPI 3.1.

The public contract describes Box lifecycle, commands, files, snapshots, limits, and typed errors. The production API base is https://boxie-api.sharenow.today.

Authentication

Use owner-approved account access.

Boxie accepts an authorized ShareNow account key as a Bearer credential. It is an account credential, not a Box-scoped delegated token. Verify the account with GET /me and capacity with GET /limits before creating compute.

When to use Boxie

Choose a real computer when the work needs one.

Use Boxie for durable files, Docker volumes, system packages, browser UI, or long-running tools that do not fit a stateless function. For unattended work, set a finite TTL, reuse one operation ID, stop in cleanup, and delete temporary Boxes.

Compatibility

Pin a dated API version.

Omit Boxie-Version to use the current contract, or send Boxie-Version: 2026-08-31 to pin it. Every response echoes the version. Unsupported versions return a typed 400. When a version is deprecated, Boxie will publish migration guidance and emit standard Deprecation and Sunset headers during the migration window.