Boxport
Docs

API

Every endpoint. JSON in, JSON out, bearer key on every call.

Base URL https://boxport.dev. Send Authorization: Bearer bk_…. Errors are {"error": "…", "next": "…"}, where next says what to do about it.

Method and pathDoes
PUT /v1/providers/:id/keyStore a vendor key, sealed. DELETE removes it. Keys are never returned.
GET /v1/providersYour providers with metering and live health.
POST /v1/templatesBuild a template on every provider. {"name","image"}; only "default" images for now.
GET /v1/quoteCost per session on each provider. Query: template, vcpu, mem, minutes, busy.
POST /v1/placeDry run of a create.
POST /v1/sandboxesCreate. Body: template, size, shape, policy. Header Idempotency-Key makes retries safe.
POST /v1/sandboxes/:id/execRun {"cmd"}; returns exit code, stdout, stderr.
POST /v1/sandboxes/:id/filesWrite {"path", "content"}: UTF-8, absolute path, 5 MiB at most (413 above).
GET /v1/sandboxes/:id/files?path=Read a file as UTF-8 text.
POST /v1/sandboxes/:id/processesStart {"cmd"} in the background; returns {"handle"}.
GET /v1/sandboxes/:id/processes/:handleOutput so far (last 1 MiB), exited and exitCode.
POST /v1/sandboxes/:id/portsURL for {"port"}. 501 where the vendor can't (Modal, Vercel, Sprites other than 8080).
DELETE /v1/sandboxes/:idKill.
GET /v1/spendYour estimated spend. Query days.
PUT /v1/spend/capsSet {"daily","perSandbox"} in dollars; null clears.
PUT /v1/spend/creditsVendor credit or prepaid commit you hold, e.g. {"daytona":{"amount":5000,"expires":"2027-06-30"}}. Replaces the list; 0 removes one. A session that fits in a vendor's remaining credit is placed as if it cost nothing, so credit is spent first while speed and health still count. Each closed sandbox's estimate is taken off the balance; caps still use list price. GET /v1/spend shows what is left.
GET /v1/scoreboardPublic provider health and prices. No key.

Defaults

size is {"vcpu":2,"memGiB":4} and shape is {"minutes":30,"busy":0.15} when left out.

Status codes

CodeMeans
401Missing or wrong Boxport key.
402A spend cap would be exceeded.
404Unknown sandbox or route.
503No provider could take it; attempts lists each try.