Sprites API Documentation

Quick Start

0 Install

export SPRITES_TOKEN=acme/1ef8/...

$ go get github.com/superfly/sprites-go

$ npm install @fly/sprites

$ pip install sprites-py

# Add to mix.exs
{:sprites, github: "superfly/sprites-ex"}

1 Create a sprite

curl -X POST "https://api.sprites.dev/v1/sprites" \
  -H "Authorization: Bearer $SPRITES_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"my-sprite"}'

client := sprites.New(os.Getenv("SPRITE_TOKEN"))
client.CreateSprite(ctx, os.Getenv("SPRITE_NAME"), nil)

import { SpritesClient } from '@fly/sprites';
const client = new SpritesClient(process.env.SPRITE_TOKEN!);
await client.createSprite(process.env.SPRITE_NAME!);

import os
from sprites import SpritesClient
client = SpritesClient(os.environ["SPRITE_TOKEN"])
client.create_sprite(os.environ["SPRITE_NAME"])

client = Sprites.new(System.get_env("SPRITE_TOKEN"))
Sprites.create(client, System.get_env("SPRITE_NAME"))

2 Run Python

echo 'print(2+2)' | curl -X POST "https://api.sprites.dev/v1/sprites/my-sprite/exec?cmd=python&stdin=true" \
  -H "Authorization: Bearer $SPRITES_TOKEN" \
  --data-binary @-

output, _ := client.Sprite(os.Getenv("SPRITE_NAME")).Command("python", "-c", "print(2+2)").Output()
	fmt.Print(string(output))

const result = await client.sprite(process.env.SPRITE_NAME!).execFile('python', ['-c', 'print(2+2)']);
process.stdout.write(result.stdout);

output = client.sprite(os.environ["SPRITE_NAME"]).command("python", "-c", "print(2+2)").output()
print(output.decode(), end="")

{output, _} = Sprites.cmd(Sprites.sprite(client, System.get_env("SPRITE_NAME")), "python", ["-c", "print(2+2)"])
IO.write(output)

3 Clean up

curl -X DELETE "https://api.sprites.dev/v1/sprites/my-sprite" \
  -H "Authorization: Bearer $SPRITES_TOKEN"

client.DestroySprite(ctx, os.Getenv("SPRITE_NAME"))

await client.deleteSprite(process.env.SPRITE_NAME!);

client.delete_sprite(os.environ["SPRITE_NAME"])

Sprites.destroy(Sprites.sprite(client, System.get_env("SPRITE_NAME")))

Orchestration

Sprites

Provision and manage isolated Linux sandboxes with persistent filesystems.

POST Create sprite GET List sprites GET Get sprite PUT Update sprite DELETE Delete sprite

Commands

Exec

Execute commands inside sprites via WebSocket. Stream stdin/stdout and manage processes.

WSS Start command GET List sessions WSS Attach to session

Services

Manage persistent background services running in sprites.

Filesystem

Read, write, and manage files within sprites.

Storage

Checkpoints

Create point-in-time snapshots and restore to previous states.

POST Create checkpoint GET List checkpoints GET Get checkpoint POST Restore checkpoint

Networking

Proxy

Tunnel TCP connections to ports inside sprites.

WSS Connect to port

Network Policy

Control outbound network access with DNS-based filtering rules.

GET Get policy POST Update policy