Sprites

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Experimental (how to enable).
  • Authentication: API key.
  • Connection: The key from SPRITES_TOKEN is sent as the Bearer prefixed Authorization header.
  • Provider documentation: Authentication reference.

Credentials

Set these per environment. See Connect an integration.

VariableRequiredDescription
SPRITES_TOKENYesSprites API token in org/token-id/secret format, generated at sprites.dev/account; same env var used by the Sprites CLI and SDKs Docs.

Setup

  1. Create a Sprites account: Sign up at https://sprites.dev by signing in with a Fly.io account (Sprites is made by Fly.io); new accounts can create sprites right away for testing.
  2. Generate an API token: Go to https://sprites.dev/account and generate an API token. Tokens have the format my-org/token-id/secret. (Alternatively, install the sprite CLI and run sprite org auth.)
  3. Set the environment variable: Copy the token into your .env as SPRITES_TOKEN.
  4. Verify access: Run List Sprites to confirm the token works, then create a sprite and execute a command in it.

Provider notes

  • The API is served on https://api.sprites.dev/v1 and authenticates with Authorization: Bearer $SPRITES_TOKEN
  • Sprites are stateful: the filesystem persists across suspends, and sprites wake automatically on use (status moves between cold, warm, and running)
  • Destroying a sprite permanently deletes its persisted state
  • Execute Command uses the HTTP POST exec endpoint for non-interactive commands; interactive TTY sessions, filesystem APIs, checkpoints, and services are WebSocket/SDK-first and not covered by these tools

Provider API reference.

Tools

ToolAccessDescription
List Sprites<br /><code className="reference-identifier">sprites__list_sprites</code>ReadList sprites
Create Sprite<br /><code className="reference-identifier">sprites__create_sprite</code>WriteCreate sprite
Get Sprite<br /><code className="reference-identifier">sprites__get_sprite</code>ReadGet sprite
Destroy Sprite<br /><code className="reference-identifier">sprites__delete_sprite</code>WritePermanently destroy sprite and filesystem
Execute Command<br /><code className="reference-identifier">sprites__exec_command</code>WriteExecute command
Create Checkpoint<br /><code className="reference-identifier">sprites__create_checkpoint</code>WriteCreate checkpoint
List Checkpoints<br /><code className="reference-identifier">sprites__list_checkpoints</code>ReadList checkpoints
Restore Checkpoint<br /><code className="reference-identifier">sprites__restore_checkpoint</code>WriteReplace sprite state with checkpoint

Verify the connection

Call a read tool such as sprites__list_sprites with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.