Sprites API

Create Sprite

POST/v1/sprites

Creates a new sprite with a unique name within your organization. The sprite starts in a 'cold' state and will warm up on first request.

Request Body

name:string

Unique name for the sprite within the organization

wait_for_capacity:optionalboolean

If true, wait for VM capacity before returning (default: false)

url_settings:optionalobject

URL access configuration

auth:optionalstring

"sprite" (default) or "public"

Responses

Status	Description
201	Created - Sprite created successfully
400	Bad Request - Invalid request body or name already exists
401	Unauthorized - Invalid or missing token

Request

HTTP

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

import { SpritesClient } from "@anthropic-ai/sprites";

const client = new SpritesClient(process.env.SPRITE_TOKEN);
const spriteName = process.env.SPRITE_NAME;

await client.createSprite(spriteName);
console.log(`Sprite '${spriteName}' created`);

from sprites import SpritesClient
import os

token = os.environ["SPRITE_TOKEN"]
sprite_name = os.environ["SPRITE_NAME"]

client = SpritesClient(token)
client.create_sprite(sprite_name)
print(f"Sprite '{sprite_name}' created")

token := os.Getenv("SPRITE_TOKEN")
spriteName := os.Getenv("SPRITE_NAME")

client := sprites.New(token)
_, err := client.CreateSprite(context.Background(), spriteName, nil)
if err != nil {
log.Fatal(err)
}
fmt.Printf("Sprite '%s' created\n", spriteName)

token = System.get_env("SPRITE_TOKEN")
sprite_name = System.get_env("SPRITE_NAME")

client = Sprites.new(token)
{:ok, _sprite} = Sprites.create(client, sprite_name)
IO.puts("Sprite '#{sprite_name}' created")

Response

{
"id": "01234567-89ab-cdef-0123-456789abcdef",
"name": "my-sprite",
"organization": "my-org",
"url": "https://my-sprite-abc123.sprites.app",
"url_settings": {
  "auth": "sprite"
},
"status": "cold",
"created_at": "2026-01-13T10:30:00Z",
"updated_at": "2026-01-13T10:30:00Z"
}

---

List Sprites

GET/v1/sprites

Lists all sprites for the authenticated organization. Supports pagination and filtering by name prefix.

Query Parameters

prefix:optionalstring

Filter sprites by name prefix

max_results:optionalnumber

Maximum results to return (1-50, default: 50)

continuation_token:optionalstring

Token from previous response for pagination

Responses

Status	Description
200	Success - Returns list of sprites
401	Unauthorized - Invalid or missing token

Request

HTTP

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

import { SpritesClient } from "@anthropic-ai/sprites";

const client = new SpritesClient(process.env.SPRITE_TOKEN);

const sprites = await client.listSprites();
console.log(JSON.stringify(sprites, null, 2));

from sprites import SpritesClient
import os
import json

token = os.environ["SPRITE_TOKEN"]

client = SpritesClient(token)
sprites = client.list_sprites()
print(json.dumps([{"name": s.name} for s in sprites.sprites], indent=2))

token := os.Getenv("SPRITE_TOKEN")

client := sprites.New(token)
list, err := client.ListSprites(context.Background(), nil)
if err != nil {
log.Fatal(err)
}
out, _ := json.MarshalIndent(list.Sprites, "", "  ")
fmt.Println(string(out))

token = System.get_env("SPRITE_TOKEN")

client = Sprites.new(token)
{:ok, sprites} = Sprites.list(client)
sprites |> Jason.encode!(pretty: true) |> IO.puts()

Response

{
"sprites": [
  {
    "name": "my-sprite",
    "org_slug": "my-org",
    "updated_at": "2026-01-13T10:30:00Z"
  },
  {
    "name": "dev-sprite",
    "org_slug": "my-org",
    "updated_at": "2026-01-12T08:15:00Z"
  }
],
"has_more": false,
"next_continuation_token": null
}

---

Get Sprite

GET/v1/sprites/{name}

Retrieves details for a specific sprite by name.

Responses

Status	Description
200	Success - Returns sprite details
401	Unauthorized - Invalid or missing token
404	Not Found - Sprite does not exist

Request

HTTP

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

import { SpritesClient } from "@anthropic-ai/sprites";

const client = new SpritesClient(process.env.SPRITE_TOKEN);
const spriteName = process.env.SPRITE_NAME;

const sprite = await client.getSprite(spriteName);
console.log(JSON.stringify(sprite, null, 2));

from sprites import SpritesClient
import os
import json

token = os.environ["SPRITE_TOKEN"]
sprite_name = os.environ["SPRITE_NAME"]

client = SpritesClient(token)
sprite = client.get_sprite(sprite_name)
print(json.dumps({"name": sprite.name}, indent=2))

token := os.Getenv("SPRITE_TOKEN")
spriteName := os.Getenv("SPRITE_NAME")

client := sprites.New(token)
sprite, err := client.GetSprite(context.Background(), spriteName)
if err != nil {
log.Fatal(err)
}
out, _ := json.MarshalIndent(sprite, "", "  ")
fmt.Println(string(out))

token = System.get_env("SPRITE_TOKEN")
sprite_name = System.get_env("SPRITE_NAME")

client = Sprites.new(token)
{:ok, sprite} = Sprites.get_sprite(client, sprite_name)
sprite |> Jason.encode!(pretty: true) |> IO.puts()

Response

{
"id": "01234567-89ab-cdef-0123-456789abcdef",
"name": "my-sprite",
"organization": "my-org",
"url": "https://my-sprite-abc123.sprites.app",
"url_settings": {
  "auth": "sprite"
},
"status": "running",
"created_at": "2026-01-13T10:30:00Z",
"updated_at": "2026-01-13T14:22:00Z"
}

---

Update Sprite

PUT/v1/sprites/{name}

Updates settings for an existing sprite. Currently supports updating URL authentication settings.

Request Body

url_settings:object

URL access configuration

auth:string

"sprite" or "public"

Responses

Status	Description
200	Success - Returns updated sprite
400	Bad Request - Invalid request body
401	Unauthorized - Invalid or missing token
404	Not Found - Sprite does not exist

Request

HTTP

curl -X PUT \
-H "Authorization: Bearer $SPRITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"url_settings": {"auth": "public"}}' \
"https://api.sprites.dev/v1/sprites/$SPRITE_NAME"

import { SpritesClient } from "@anthropic-ai/sprites";

const client = new SpritesClient(process.env.SPRITE_TOKEN);
const spriteName = process.env.SPRITE_NAME;

await client.updateURLSettings(spriteName, { auth: "public" });
console.log("URL settings updated");

from sprites import SpritesClient, URLSettings
import os

token = os.environ["SPRITE_TOKEN"]
sprite_name = os.environ["SPRITE_NAME"]

client = SpritesClient(token)
client.update_url_settings(sprite_name, URLSettings(auth="public"))
print("URL settings updated")

token := os.Getenv("SPRITE_TOKEN")
spriteName := os.Getenv("SPRITE_NAME")

client := sprites.New(token)
err := client.UpdateURLSettings(context.Background(), spriteName, &sprites.URLSettings{
Auth: "public",
})
if err != nil {
log.Fatal(err)
}
fmt.Println("URL settings updated")

token = System.get_env("SPRITE_TOKEN")
sprite_name = System.get_env("SPRITE_NAME")

client = Sprites.new(token)
sprite = Sprites.sprite(client, sprite_name)
:ok = Sprites.update_url_settings(sprite, %{auth: "public"})
IO.puts("URL settings updated")

Response

{
"id": "01234567-89ab-cdef-0123-456789abcdef",
"name": "my-sprite",
"organization": "my-org",
"url": "https://my-sprite-abc123.sprites.app",
"url_settings": {
  "auth": "public"
},
"status": "running",
"created_at": "2026-01-13T10:30:00Z",
"updated_at": "2026-01-13T15:00:00Z"
}

---

Delete Sprite

DELETE/v1/sprites/{name}

Permanently deletes a sprite and all associated resources. This action cannot be undone.

Responses

Status	Description
204	No Content - Sprite deleted successfully
401	Unauthorized - Invalid or missing token
404	Not Found - Sprite does not exist

Request

HTTP

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

import { SpritesClient } from "@anthropic-ai/sprites";

const client = new SpritesClient(process.env.SPRITE_TOKEN);
const spriteName = process.env.SPRITE_NAME;

await client.deleteSprite(spriteName);
console.log(`Sprite '${spriteName}' destroyed`);

from sprites import SpritesClient
import os

token = os.environ["SPRITE_TOKEN"]
sprite_name = os.environ["SPRITE_NAME"]

client = SpritesClient(token)
client.delete_sprite(sprite_name)
print(f"Sprite '{sprite_name}' destroyed")

token := os.Getenv("SPRITE_TOKEN")
spriteName := os.Getenv("SPRITE_NAME")

client := sprites.New(token)
err := client.DestroySprite(context.Background(), spriteName)
if err != nil {
log.Fatal(err)
}
fmt.Printf("Sprite '%s' destroyed\n", spriteName)

token = System.get_env("SPRITE_TOKEN")
sprite_name = System.get_env("SPRITE_NAME")

client = Sprites.new(token)
sprite = Sprites.sprite(client, sprite_name)
:ok = Sprites.destroy(sprite)
IO.puts("Sprite '#{sprite_name}' destroyed")