Skip to main content

Slothbox API

The Slothbox REST API is what powers the web app, the CLI, and anything you build on top. This site is the reference for the live deployment at api.slothbox.dev.

info

These docs are generated from the API source on every deploy, so what you see here matches what is actually live.

Get started​

  • Quickstart — your first request end-to-end.
  • Authentication — how API keys and Cognito tokens fit together.
  • API plan — the standalone, flat-rate plan for unlimited headless automation, and how it coexists with per-seat.
  • Errors — the shape of error responses and what each status code means.

Tools​

  • SDKs — official client libraries for building on the API, starting with TypeScript.
  • Box services — add Docker-based databases, caches, and your own images to an environment template.
  • CLI — sign in and manage your environments from the terminal.
  • MCP server — connect Claude, Cursor, or any MCP client to read your Slothbox data.
  • Webhooks — receive signed events when environments, members, connections, or billing change.

Reference​

  • API reference — every endpoint, request schema, and response shape, generated from the API.

How the reference is generated​

The interactive API reference is rendered by Scalar directly from the OpenAPI document the API serves at /openapi.json. That document is the single source of truth: it is produced by the API's own OpenAPI registry and synced into this site at build time, then handed to Scalar on the reference page.

Because of that pipeline, endpoint-level changes flow through automatically. When the API adds or updates a route — for example the service-account-key endpoints used by the API plan — its request and response schemas show up in the reference on the next build, with no hand-editing here.

The same OpenAPI document drives the client SDKs: SDK methods are generated from, and named after, the operations you see in the reference, so the two always describe the same surface.

The narrative guides are hand-written, and they are where the "why" and "how" live — including Authentication, API plan, Headless authentication, and Fair use. When the API changes in a way that needs explanation rather than just a new schema, those are the pages to update.

Trying requests from the reference​

Each operation in the reference has a Try it panel. Paste any sk_ key into the API key field and Scalar sends it in the Authorization header with no Bearer prefix — exactly how the API expects it. Both kinds of sk_ key work: a personal seat key and an organization service-account key are interchangeable here, so you can exercise either against live endpoints.