⌘K
DocsDeveloper reference

The developer reference

Everything Spaceboy can do, in the lane you build in: the CLI, the HTTP API, or the npm SDK.

One platform, three lanes

Everything the dashboard can do, you can automate. Spaceboy exposes a single GraphQL API, and every surface — the web app, the iOS app, the CLI, and the npm SDK — is built on it. This reference documents each capability once and shows it in all three lanes, so you pick how you integrate, not what you can reach.

  • CLI — the spaceboy command: terminals, shell scripts, CI pipelines, and coding agents. Non-interactive, --json output, meaningful exit codes.
  • API — raw GraphQL over HTTPS: any language, any runtime, nothing to install. One endpoint, introspectable schema.
  • npm — the @spaceboy-ai/sdk package: typed methods for TypeScript and JavaScript applications, wrapping the same operations.

Try the toggle — your choice sticks across every example in the docs:

spaceboy whoami

Picking a lane

  • Scripting from a shell, CI job, or coding agent? Start with the CLI — it adds device login, built-in polling for long operations, and structured JSON errors.
  • Building Spaceboy into a TypeScript or JavaScript app? Use the npm SDK — typed inputs and results, no GraphQL documents to maintain.
  • Integrating from another language or need an operation the wrappers don't cover? Call the API directly — the CLI and SDK are supported wrappers over this exact endpoint, so anything they do, you can do raw.

Every lane is included on every plan, Free included. A capability that is plan-gated (full-stack deploys, Enterprise exports) is gated identically in all three lanes.

How this reference is organized

Capabilities are grouped by what you're doing — projects, setup, tasks, deploys, billing — not by which tool you hold. Expand a topic in the sidebar and each operation is its own entry: the fastest path from "I want to start a project from npm" to working code.

Install your laneThen authenticate