Sprites API Documentation

Create Sprite

POST /v1/sprites

Create a new sprite with a unique name in your organization

Request Body

application/json

name* string

Unique name for the sprite within the organization

wait_for_capacity boolean

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

url_settings

URL access configuration

auth "sprite" | "public"

Authentication type (default: sprite)

Response

application/json

id* string

Unique sprite identifier (UUID)

name* string

Sprite name within the organization

organization* string

Organization slug

url* string

Sprite HTTP endpoint URL

url_settings

URL access configuration

auth* "sprite" | "public"

Authentication type

status* "cold" | "warm" | "running"

Runtime status

created_at* string

Creation timestamp (ISO 8601)

updated_at* string

Last update timestamp (ISO 8601)

Response Codes

201

Created

400

Invalid request parameters

401

Missing or invalid authentication

bash

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

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)

// Example: Create Sprite
// Endpoint: POST /v1/sprites


const token = process.env.SPRITE_TOKEN!;
const spriteName = process.env.SPRITE_NAME!;

const client = new SpritesClient(token);

await client.createSprite(spriteName);

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

import os

from sprites import SpritesClient

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 = 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")

200 Response

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

Sprite 'flame-ranger' created

Sprite 'golden-spark' created

Sprite 'astral-hawk' created

Sprite 'wild-pulse' created

List Sprites

GET /v1/sprites

List all sprites for the authenticated organization

Query Parameters

prefix string

Filter sprites by name prefix

max_results number

Maximum number of results (1-50, default: 50)

continuation_token string

Token from previous response for pagination

Response

application/json

sprites* SpriteEntry[]

List of sprite entries

name* string

Sprite name

org_slug* string

Organization slug

updated_at string

Last update timestamp (ISO 8601)

has_more* boolean

Whether more results are available

next_continuation_token string

Token for fetching the next page of results

Response Codes

200

Success

401

Missing or invalid authentication

bash

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

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))

// Example: List Sprites
// Endpoint: GET /v1/sprites


const token = process.env.SPRITE_TOKEN!;

const client = new SpritesClient(token);

const sprites = await client.listSprites();

console.log(JSON.stringify(sprites, null, 2));

import json
import os

from sprites import SpritesClient

token = os.environ["SPRITE_TOKEN"]

client = SpritesClient(token)

sprites = client.list_sprites()

result = []
for s in sprites:
    item = {"name": s.name}
    if s.id:
        item["id"] = s.id
    if s.status:
        item["status"] = s.status
    if s.url:
        item["url"] = s.url
    result.append(item)

print(json.dumps(result, indent=2))

token = System.get_env("SPRITE_TOKEN")

client = Sprites.new(token)

{:ok, sprites} = Sprites.list(client)

sprites
|> Jason.encode!(pretty: true)
|> IO.puts()

200 Response

{
  "sprites": [
    {
      "name": "my-dev-sprite",
      "updated_at": "2024-01-15T14:22:00Z",
      "org_slug": "my-org"
    }
  ],
  "next_continuation_token": "eyJsYXN0IjoibXktZGV2LXNwcml0ZSJ9",
  "has_more": true
}

[
  {
    "id": "sprite-d9412eaa-7a68-42f6-afd6-07058fbc5431",
    "name": "flame-ranger",
    "organization": "sprites-automated-tests",
    "status": "running",
    "created_at": "2026-01-06T23:56:29.225227Z",
    "updated_at": "2026-01-06T23:56:29.886446Z",
    "url": "https://flame-ranger-bhmkr.sprites.app",
    "url_settings": {
      "auth": "sprite"
    }
  },
  {
    "id": "sprite-a769ac3b-b303-4be9-8214-9ed7626b7d24",
    "name": "neon-fox",
    "organization": "sprites-automated-tests",
    "status": "running",
    "created_at": "2026-01-06T23:05:12.764221Z",
    "updated_at": "2026-01-06T23:05:14.859619Z",
    "url": "https://neon-fox-bhmkr.sprites.app",
    "url_settings": {
      "auth": "sprite"
    }
  },
  {
    "id": "sprite-d21e81f5-ee4a-46de-952d-2cd6ec66e65c",
    "name": "steel-ranger",
    "organization": "sprites-automated-tests",
    "status": "cold",
    "created_at": "2026-01-06T22:34:46.552931Z",
    "updated_at": "2026-01-06T22:34:46.552931Z",
    "url": "https://steel-ranger-bhmkr.sprites.app",
    "url_settings": {
      "auth": "sprite"
    }
  },
  {
    "id": "sprite-7550fb4c-24a5-41a0-a771-5263899403f1",
    "name": "steel-raven",
    "organization": "sprites-automated-tests",
    "status": "running",
    "created_at": "2026-01-06T23:11:01.581319Z",
    "updated_at": "2026-01-06T23:11:03.383265Z",
    "url": "https://steel-raven-bhmkr.sprites.app",
    "url_settings": {
      "auth": "sprite"
    }
  }
]

{
  "sprites": [
    {
      "id": "sprite-769719c8-2165-40b3-802d-dda0d31023f8",
      "name": "golden-spark",
      "status": "running",
      "url": "https://golden-spark-bhmkr.sprites.app",
      "updated_at": "2026-01-06T23:56:51.314944Z",
      "organization": "sprites-automated-tests",
      "created_at": "2026-01-06T23:56:49.416662Z",
      "url_settings": {
        "auth": "sprite"
      }
    },
    {
      "id": "sprite-a769ac3b-b303-4be9-8214-9ed7626b7d24",
      "name": "neon-fox",
      "status": "running",
      "url": "https://neon-fox-bhmkr.sprites.app",
      "updated_at": "2026-01-06T23:05:14.859619Z",
      "organization": "sprites-automated-tests",
      "created_at": "2026-01-06T23:05:12.764221Z",
      "url_settings": {
        "auth": "sprite"
      }
    },
    {
      "id": "sprite-d21e81f5-ee4a-46de-952d-2cd6ec66e65c",
      "name": "steel-ranger",
      "status": "cold",
      "url": "https://steel-ranger-bhmkr.sprites.app",
      "updated_at": "2026-01-06T22:34:46.552931Z",
      "organization": "sprites-automated-tests",
      "created_at": "2026-01-06T22:34:46.552931Z",
      "url_settings": {
        "auth": "sprite"
      }
    },
    {
      "id": "sprite-7550fb4c-24a5-41a0-a771-5263899403f1",
      "name": "steel-raven",
      "status": "running",
      "url": "https://steel-raven-bhmkr.sprites.app",
      "updated_at": "2026-01-06T23:11:03.383265Z",
      "organization": "sprites-automated-tests",
      "created_at": "2026-01-06T23:11:01.581319Z",
      "url_settings": {
        "auth": "sprite"
      }
    }
  ],
  "has_more": true,
  "next_continuation_token": null
}

[
  {
    "name": "astral-hawk",
    "id": "sprite-0f9e93d9-0a1e-4197-a9f3-7bda09dfe8d4",
    "status": "running",
    "url": "https://astral-hawk-bhmkr.sprites.app"
  },
  {
    "name": "cyber-runner",
    "id": "sprite-0eb35e63-aa79-448d-b37b-65b71d462df4",
    "status": "running",
    "url": "https://cyber-runner-bhmkr.sprites.app"
  },
  {
    "name": "neon-fox",
    "id": "sprite-a769ac3b-b303-4be9-8214-9ed7626b7d24",
    "status": "running",
    "url": "https://neon-fox-bhmkr.sprites.app"
  },
  {
    "name": "nova-titan",
    "id": "sprite-2d084682-6b0c-4a84-a5dc-4d08c0773d07",
    "status": "running",
    "url": "https://nova-titan-bhmkr.sprites.app"
  },
  {
    "name": "pixel-blade",
    "id": "sprite-a4fd806d-4f07-4847-ad27-9aede00e6e51",
    "status": "cold",
    "url": "https://pixel-blade-bhmkr.sprites.app"
  },
  {
    "name": "steel-ranger",
    "id": "sprite-d21e81f5-ee4a-46de-952d-2cd6ec66e65c",
    "status": "running",
    "url": "https://steel-ranger-bhmkr.sprites.app"
  },
  {
    "name": "steel-raven",
    "id": "sprite-7550fb4c-24a5-41a0-a771-5263899403f1",
    "status": "running",
    "url": "https://steel-raven-bhmkr.sprites.app"
  }
]

[
  {
    "created_at": "2026-01-06T23:05:12.764221Z",
    "id": "sprite-a769ac3b-b303-4be9-8214-9ed7626b7d24",
    "name": "neon-fox",
    "organization": "sprites-automated-tests",
    "status": "running",
    "updated_at": "2026-01-06T23:05:14.859619Z",
    "url": "https://neon-fox-bhmkr.sprites.app",
    "url_settings": {
      "auth": "sprite"
    }
  },
  {
    "created_at": "2026-01-06T22:34:46.552931Z",
    "id": "sprite-d21e81f5-ee4a-46de-952d-2cd6ec66e65c",
    "name": "steel-ranger",
    "organization": "sprites-automated-tests",
    "status": "running",
    "updated_at": "2026-01-07T00:24:52.002226Z",
    "url": "https://steel-ranger-bhmkr.sprites.app",
    "url_settings": {
      "auth": "sprite"
    }
  },
  {
    "created_at": "2026-01-06T23:11:01.581319Z",
    "id": "sprite-7550fb4c-24a5-41a0-a771-5263899403f1",
    "name": "steel-raven",
    "organization": "sprites-automated-tests",
    "status": "running",
    "updated_at": "2026-01-06T23:11:03.383265Z",
    "url": "https://steel-raven-bhmkr.sprites.app",
    "url_settings": {
      "auth": "sprite"
    }
  },
  {
    "created_at": "2026-01-07T00:27:45.262479Z",
    "id": "sprite-d233aed8-3cc9-4401-9663-7ff7b0ce5896",
    "name": "wild-pulse",
    "organization": "sprites-automated-tests",
    "status": "running",
    "updated_at": "2026-01-07T00:27:46.958492Z",
    "url": "https://wild-pulse-bhmkr.sprites.app",
    "url_settings": {
      "auth": "sprite"
    }
  }
]

Get Sprite

GET /v1/sprites/{name}

Get details for a specific sprite

Path Parameters

name* string

Unique sprite name

Response

application/json

id* string

Unique sprite identifier (UUID)

name* string

Sprite name within the organization

organization* string

Organization slug

url* string

Sprite HTTP endpoint URL

url_settings

URL access configuration

auth* "sprite" | "public"

Authentication type

status* "cold" | "warm" | "running"

Runtime status

created_at* string

Creation timestamp (ISO 8601)

updated_at* string

Last update timestamp (ISO 8601)

Response Codes

200

Success

401

Missing or invalid authentication

404

Sprite not found

bash

curl -X GET \
  "https://api.sprites.dev/v1/sprites/{name}" \
  -H "Authorization: Bearer $SPRITES_TOKEN"

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))

// Example: Get Sprite
// Endpoint: GET /v1/sprites/{name}


const token = process.env.SPRITE_TOKEN!;
const spriteName = process.env.SPRITE_NAME!;

const client = new SpritesClient(token);

const sprite = await client.getSprite(spriteName);

console.log(JSON.stringify(sprite, null, 2));

import json
import os

from sprites import SpritesClient

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

client = SpritesClient(token)

sprite = client.get_sprite(sprite_name)

result = {"name": sprite.name}
if sprite.info:
    if sprite.info.id:
        result["id"] = sprite.info.id
    if sprite.info.status:
        result["status"] = sprite.info.status
    if sprite.info.url:
        result["url"] = sprite.info.url

print(json.dumps(result, indent=2))

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()

200 Response

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

{
  "ID": "sprite-d9412eaa-7a68-42f6-afd6-07058fbc5431",
  "OrganizationName": "sprites-automated-tests",
  "Status": "running",
  "Config": null,
  "Environment": null,
  "CreatedAt": "2026-01-06T23:56:29.225227Z",
  "UpdatedAt": "2026-01-06T23:56:29.886446Z",
  "BucketName": "",
  "PrimaryRegion": "",
  "URL": "https://flame-ranger-bhmkr.sprites.app",
  "URLSettings": {
    "auth": "sprite"
  }
}

{
  "name": "golden-spark",
  "client": {
    "baseURL": "https://api.sprites.dev",
    "token": "sprites-automated-tests/1290577/0de1ba1d767601c13ded2dc1e48c025a/0e61ed948c66b60f816fa958f039a04f0f6a6fa92e46ea9ac9e2619f830fc11b",
    "timeout": 30000
  },
  "id": "sprite-769719c8-2165-40b3-802d-dda0d31023f8",
  "status": "running",
  "url": "https://golden-spark-bhmkr.sprites.app",
  "updated_at": "2026-01-06T23:56:51.314944Z",
  "organization": "sprites-automated-tests",
  "created_at": "2026-01-06T23:56:49.416662Z",
  "url_settings": {
    "auth": "sprite"
  }
}

{
  "name": "astral-hawk",
  "id": "sprite-0f9e93d9-0a1e-4197-a9f3-7bda09dfe8d4",
  "status": "running",
  "url": "https://astral-hawk-bhmkr.sprites.app"
}

{
  "created_at": "2026-01-07T00:27:45.262479Z",
  "id": "sprite-d233aed8-3cc9-4401-9663-7ff7b0ce5896",
  "name": "wild-pulse",
  "organization": "sprites-automated-tests",
  "status": "running",
  "updated_at": "2026-01-07T00:27:46.958492Z",
  "url": "https://wild-pulse-bhmkr.sprites.app",
  "url_settings": {
    "auth": "sprite"
  }
}

Destroy Sprite

DELETE /v1/sprites/{name}

Delete a sprite and all associated resources

Path Parameters

name* string

Unique sprite name

Response

application/json

Response Codes

204

No content

401

Missing or invalid authentication

404

Sprite not found

bash

curl -X DELETE \
  "https://api.sprites.dev/v1/sprites/{name}" \
  -H "Authorization: Bearer $SPRITES_TOKEN"

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)

// Example: Destroy Sprite
// Endpoint: DELETE /v1/sprites/{name}


const token = process.env.SPRITE_TOKEN!;
const spriteName = process.env.SPRITE_NAME!;

const client = new SpritesClient(token);

await client.deleteSprite(spriteName);

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

import os

from sprites import SpritesClient

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 = 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")

200 Response

Sprite 'flame-ranger' destroyed

Sprite 'golden-spark' destroyed

Sprite 'astral-hawk' destroyed

Sprite 'wild-pulse' destroyed

Update Sprite

PUT /v1/sprites/{name}

Update sprite settings such as URL authentication

Path Parameters

name* string

Unique sprite name

Request Body

application/json

url_settings*

URL access configuration to update

auth "sprite" | "public"

Authentication type (default: sprite)

Response

application/json

id* string

Unique sprite identifier (UUID)

name* string

Sprite name within the organization

organization* string

Organization slug

url* string

Sprite HTTP endpoint URL

url_settings

URL access configuration

auth* "sprite" | "public"

Authentication type

status* "cold" | "warm" | "running"

Runtime status

created_at* string

Creation timestamp (ISO 8601)

updated_at* string

Last update timestamp (ISO 8601)

Response Codes

200

Success

400

Invalid request parameters

401

Missing or invalid authentication

404

Sprite not found

bash

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

import os

from sprites import SpritesClient, URLSettings

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 = 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")

200 Response

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

URL settings updated

URL settings updated

Sprite Management

Create Sprite

Request Body

Response

Response Codes

List Sprites

Query Parameters

Response

Response Codes

Get Sprite

Path Parameters

Response

Response Codes

Destroy Sprite

Path Parameters

Response

Response Codes

Update Sprite

Path Parameters

Request Body

Response

Response Codes