API reference

curl https://www.sprite-ai.art/api/me \
-H "Authorization: Bearer sai_sk_your_key_here"

const res = await fetch("https://www.sprite-ai.art/api/me", {
headers: { Authorization: "Bearer sai_sk_your_key_here" },
});
const account = await res.json();

import requests

account = requests.get(
  "https://www.sprite-ai.art/api/me",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
).json()

curl https://www.sprite-ai.art/api/balance \
-H "Authorization: Bearer sai_sk_your_key_here"

const res = await fetch("https://www.sprite-ai.art/api/balance", {
headers: { Authorization: "Bearer sai_sk_your_key_here" },
});
const { total_token_balance } = await res.json();

import requests

balance = requests.get(
  "https://www.sprite-ai.art/api/balance",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
).json()

curl https://www.sprite-ai.art/api/asset-types \
-H "Authorization: Bearer sai_sk_your_key_here"

const res = await fetch("https://www.sprite-ai.art/api/asset-types", {
headers: { Authorization: "Bearer sai_sk_your_key_here" },
});
const { asset_types } = await res.json();

import requests

asset_types = requests.get(
  "https://www.sprite-ai.art/api/asset-types",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
).json()["asset_types"]

curl https://www.sprite-ai.art/api/limits \
-H "Authorization: Bearer sai_sk_your_key_here"

const res = await fetch("https://www.sprite-ai.art/api/limits", {
headers: { Authorization: "Bearer sai_sk_your_key_here" },
});
const limits = await res.json();

import requests

limits = requests.get(
  "https://www.sprite-ai.art/api/limits",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
).json()

curl https://www.sprite-ai.art/api/sprites \
-H "Authorization: Bearer sai_sk_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "prompt": "a knight with a blue cape", "asset_type": "character" }'

const res = await fetch("https://www.sprite-ai.art/api/sprites", {
method: "POST",
headers: {
  Authorization: "Bearer sai_sk_your_key_here",
  "Content-Type": "application/json",
},
body: JSON.stringify({
  prompt: "a knight with a blue cape",
  asset_type: "character",
}),
});
const data = await res.json(); // data.image.pngBase64

import base64, requests

res = requests.post(
  "https://www.sprite-ai.art/api/sprites",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
  json={"prompt": "a knight with a blue cape", "asset_type": "character"},
)
data = res.json()
with open("knight.png", "wb") as f:
  f.write(base64.b64decode(data["image"]["pngBase64"]))

curl https://www.sprite-ai.art/api/sprites/import \
-H "Authorization: Bearer sai_sk_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "image": "<png base64>", "title": "hero" }'

import { readFileSync } from "node:fs";

const image = readFileSync("hero.png").toString("base64");
const res = await fetch("https://www.sprite-ai.art/api/sprites/import", {
method: "POST",
headers: {
  Authorization: "Bearer sai_sk_your_key_here",
  "Content-Type": "application/json",
},
body: JSON.stringify({ image, title: "hero" }),
});
const { id } = await res.json(); // animate with source_generation_id: id

import base64, requests

image = base64.b64encode(open("hero.png", "rb").read()).decode()
res = requests.post(
  "https://www.sprite-ai.art/api/sprites/import",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
  json={"image": image, "title": "hero"},
).json()
sprite_id = res["id"]  # animate with source_generation_id

curl https://www.sprite-ai.art/api/sprites/a1b2c3d4-... \
-H "Authorization: Bearer sai_sk_your_key_here"

const res = await fetch(
"https://www.sprite-ai.art/api/sprites/a1b2c3d4-...",
{ headers: { Authorization: "Bearer sai_sk_your_key_here" } },
);
const sprite = await res.json();

import requests

sprite = requests.get(
  "https://www.sprite-ai.art/api/sprites/a1b2c3d4-...",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
).json()

curl "https://www.sprite-ai.art/api/sprites?limit=20" \
-H "Authorization: Bearer sai_sk_your_key_here"

const res = await fetch(
"https://www.sprite-ai.art/api/sprites?limit=20",
{ headers: { Authorization: "Bearer sai_sk_your_key_here" } },
);
const { sprites } = await res.json();

import requests

sprites = requests.get(
  "https://www.sprite-ai.art/api/sprites?limit=20",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
).json()["sprites"]

curl https://www.sprite-ai.art/api/animations \
-H "Authorization: Bearer sai_sk_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "source_generation_id": "a1b2c3d4-...", "preset": "Walk", "frame_count": 8 }'

const res = await fetch("https://www.sprite-ai.art/api/animations", {
method: "POST",
headers: {
  Authorization: "Bearer sai_sk_your_key_here",
  "Content-Type": "application/json",
},
body: JSON.stringify({
  source_generation_id: spriteId, // from generate or import
  preset: "Walk",
  frame_count: 8,
}),
});
const { id } = await res.json(); // poll GET /api/animations/{id}

import requests

job = requests.post(
  "https://www.sprite-ai.art/api/animations",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
  json={"source_generation_id": sprite_id, "preset": "Walk", "frame_count": 8},
).json()
job_id = job["id"]  # poll GET /api/animations/{id}

# poll every ~5s until status is completed or failed
curl https://www.sprite-ai.art/api/animations/a1b2c3d4-... \
-H "Authorization: Bearer sai_sk_your_key_here"

const headers = { Authorization: "Bearer sai_sk_your_key_here" };
while (true) {
await new Promise((r) => setTimeout(r, 5000));
const job = await (await fetch(
  "https://www.sprite-ai.art/api/animations/" + id, { headers },
)).json();
if (job.status === "completed") { console.log(job.image.spritesheetBase64); break; }
if (job.status === "failed") { console.error("render failed"); break; }
}

import time, requests

headers = {"Authorization": "Bearer sai_sk_your_key_here"}
while True:
  time.sleep(5)
  job = requests.get(
      "https://www.sprite-ai.art/api/animations/" + job_id, headers=headers,
  ).json()
  if job["status"] == "completed":
      print(job["image"]["spritesheetBase64"]); break
  if job["status"] == "failed":
      print("render failed"); break

curl -X POST https://www.sprite-ai.art/api/animations/a1b2c3d4-.../cancel \
-H "Authorization: Bearer sai_sk_your_key_here"

await fetch(
"https://www.sprite-ai.art/api/animations/" + id + "/cancel",
{ method: "POST", headers: { Authorization: "Bearer sai_sk_your_key_here" } },
);

import requests

requests.post(
  "https://www.sprite-ai.art/api/animations/" + job_id + "/cancel",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
)

curl https://www.sprite-ai.art/api/restyles \
-H "Authorization: Bearer sai_sk_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "source_generation_id": "a1b2c3d4-...", "preset": "gold" }'

const res = await fetch("https://www.sprite-ai.art/api/restyles", {
method: "POST",
headers: {
  Authorization: "Bearer sai_sk_your_key_here",
  "Content-Type": "application/json",
},
body: JSON.stringify({
  source_generation_id: spriteId, // from generate or import
  preset: "gold", // or custom_prompt: "obsidian armor, glowing runes"
}),
});
const { id } = await res.json(); // poll GET /api/restyles/{id}

import requests

job = requests.post(
  "https://www.sprite-ai.art/api/restyles",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
  json={"source_generation_id": sprite_id, "preset": "gold"},
).json()
job_id = job["id"]  # poll GET /api/restyles/{id}

# poll every ~3s until status is completed or failed
curl https://www.sprite-ai.art/api/restyles/a1b2c3d4-... \
-H "Authorization: Bearer sai_sk_your_key_here"

const headers = { Authorization: "Bearer sai_sk_your_key_here" };
while (true) {
await new Promise((r) => setTimeout(r, 3000));
const job = await (await fetch(
  "https://www.sprite-ai.art/api/restyles/" + id, { headers },
)).json();
if (job.status === "completed") { console.log(job.image.pngBase64); break; }
if (job.status === "failed") { console.error("restyle failed"); break; }
}

import time, requests

headers = {"Authorization": "Bearer sai_sk_your_key_here"}
while True:
  time.sleep(3)
  job = requests.get(
      "https://www.sprite-ai.art/api/restyles/" + job_id, headers=headers,
  ).json()
  if job["status"] == "completed":
      print(job["image"]["pngBase64"]); break
  if job["status"] == "failed":
      print("restyle failed"); break

curl -X POST https://www.sprite-ai.art/api/restyles/a1b2c3d4-.../cancel \
-H "Authorization: Bearer sai_sk_your_key_here"

await fetch(
"https://www.sprite-ai.art/api/restyles/" + id + "/cancel",
{ method: "POST", headers: { Authorization: "Bearer sai_sk_your_key_here" } },
);

import requests

requests.post(
  "https://www.sprite-ai.art/api/restyles/" + job_id + "/cancel",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
)

curl https://www.sprite-ai.art/api/combines \
-H "Authorization: Bearer sai_sk_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "source_generation_id": "a1b2c3d4-...", "item_generation_id": "e5f6a7b8-...", "prompt": "holding this shield in his free hand" }'

const res = await fetch("https://www.sprite-ai.art/api/combines", {
method: "POST",
headers: {
  Authorization: "Bearer sai_sk_your_key_here",
  "Content-Type": "application/json",
},
body: JSON.stringify({
  source_generation_id: characterId, // keeps its identity and its size
  item_generation_id: shieldId,      // where the item comes from
  prompt: "holding this shield in his free hand",
}),
});
const { id } = await res.json(); // poll GET /api/combines/{id}

import requests

job = requests.post(
  "https://www.sprite-ai.art/api/combines",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
  json={
      "source_generation_id": character_id,
      "item_generation_id": shield_id,
      "prompt": "holding this shield in his free hand",
  },
).json()
job_id = job["id"]  # poll GET /api/combines/{id}

curl https://www.sprite-ai.art/api/combines/a1b2c3d4-... \
-H "Authorization: Bearer sai_sk_your_key_here"

let job;
do {
await new Promise((r) => setTimeout(r, 3000));
job = await (await fetch(
  "https://www.sprite-ai.art/api/combines/" + id, { headers },
)).json();
if (job.status === "failed") { console.error("combine failed"); break; }
} while (job.status === "processing");

import time, requests

while True:
  time.sleep(3)
  job = requests.get(
      "https://www.sprite-ai.art/api/combines/" + job_id, headers=headers,
  ).json()
  if job["status"] != "processing":
      if job["status"] == "failed":
          print("combine failed")
      break

curl -X POST https://www.sprite-ai.art/api/combines/a1b2c3d4-.../cancel \
-H "Authorization: Bearer sai_sk_your_key_here"

await fetch(
"https://www.sprite-ai.art/api/combines/" + id + "/cancel",
{ method: "POST", headers: { Authorization: "Bearer sai_sk_your_key_here" } },
);

import requests

requests.post(
  "https://www.sprite-ai.art/api/combines/" + job_id + "/cancel",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
)

curl https://www.sprite-ai.art/api/touch-ups \
-H "Authorization: Bearer sai_sk_your_key_here" \
-H "Content-Type: application/json" \
-d '{
  "source_generation_id": "a1b2c3d4-...",
  "prompt": "glowing red eyes in the visor",
  "region": { "x": 32, "y": 10, "width": 12, "height": 11 }
}'

const res = await fetch("https://www.sprite-ai.art/api/touch-ups", {
method: "POST",
headers: {
  Authorization: "Bearer sai_sk_your_key_here",
  "Content-Type": "application/json",
},
body: JSON.stringify({
  source_generation_id: spriteId,
  prompt: "glowing red eyes in the visor",
  region: { x: 32, y: 10, width: 12, height: 11 },
}),
});
const fixed = await res.json(); // completed inline, no polling
// fixed.id is a new sprite; fixed.region is what was actually repaired

import base64, requests

fixed = requests.post(
  "https://www.sprite-ai.art/api/touch-ups",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
  json={
      "source_generation_id": sprite_id,
      "prompt": "glowing red eyes in the visor",
      "region": {"x": 32, "y": 10, "width": 12, "height": 11},
  },
).json()
with open("sprite_fixed.png", "wb") as f:
  f.write(base64.b64decode(fixed["image"]["pngBase64"]))

curl https://www.sprite-ai.art/api/rotations \
-H "Authorization: Bearer sai_sk_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "source_generation_id": "a1b2c3d4-..." }'

const res = await fetch("https://www.sprite-ai.art/api/rotations", {
method: "POST",
headers: {
  Authorization: "Bearer sai_sk_your_key_here",
  "Content-Type": "application/json",
},
body: JSON.stringify({ source_generation_id: spriteId }), // a still, 32-256px
});
const set = await res.json(); // completed inline, ~1-2 minutes
// set.directions lists the 8 frames left to right: s, se, e, ne, n, nw, w, sw

import base64, requests

rotation = requests.post(
  "https://www.sprite-ai.art/api/rotations",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
  json={"source_generation_id": sprite_id},
).json()
with open("knight_8dir.png", "wb") as f:
  f.write(base64.b64decode(rotation["image"]["spritesheetBase64"]))

curl https://www.sprite-ai.art/api/normal-maps \
-H "Authorization: Bearer sai_sk_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "source_generation_id": "a1b2c3d4-..." }'

const res = await fetch("https://www.sprite-ai.art/api/normal-maps", {
method: "POST",
headers: {
  Authorization: "Bearer sai_sk_your_key_here",
  "Content-Type": "application/json",
},
body: JSON.stringify({
  source_generation_id: spriteId, // a sprite OR an animation
}),
});
const map = await res.json(); // completed inline, no polling
// convention most engines auto-detect: save as <sprite-name>_n.png

import base64, requests

map = requests.post(
  "https://www.sprite-ai.art/api/normal-maps",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
  json={"source_generation_id": sprite_id},
).json()
with open("sprite_n.png", "wb") as f:
  f.write(base64.b64decode(map["image"]["pngBase64"]))

curl https://www.sprite-ai.art/api/background-removals \
-H "Authorization: Bearer sai_sk_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "source_generation_id": "a1b2c3d4-...", "method": "refined" }'

const res = await fetch("https://www.sprite-ai.art/api/background-removals", {
method: "POST",
headers: {
  Authorization: "Bearer sai_sk_your_key_here",
  "Content-Type": "application/json",
},
body: JSON.stringify({
  source_generation_id: spriteId, // an imported screenshot or render
  method: "refined",              // omit for the free standard method
}),
});
const cutout = await res.json(); // completed inline, no polling
// cutout.id is a new sprite: animate or restyle it like any other

import base64, requests

cutout = requests.post(
  "https://www.sprite-ai.art/api/background-removals",
  headers={"Authorization": "Bearer sai_sk_your_key_here"},
  json={"source_generation_id": sprite_id, "method": "refined"},
).json()
with open("sprite_cutout.png", "wb") as f:
  f.write(base64.b64decode(cutout["image"]["pngBase64"]))