API Reference

The Sprites API allows you to manage Sprites programmatically via HTTP and WebSocket requests.

Base URL

https://api.sprites.dev

Authentication

All API requests require authentication via Bearer token:

curl -H "Authorization: Bearer $SPRITE_TOKEN" \
  https://api.sprites.dev/v1/sprites

Create a token at sprites.dev/account, or generate one via the CLI with sprite org auth.

API Categories

Sprites

Create, list, update, and delete Sprites

Checkpoints

Create, list, and restore environment snapshots

Exec

Execute commands in Sprites via WebSocket

Filesystem

Browse and manage the filesystem

Policy

Manage access control policies

HTTP Proxy

Forward HTTP requests to services inside Sprites

Services

Manage background services running in Sprites

SDK Libraries

For a better developer experience, use our official SDKs:

JavaScript SDK

TypeScript/JavaScript client

Go SDK

Native Go client

Python SDK

Python client library

Elixir SDK

Elixir client library

Version

API Version: 0.0.1-dev