Assets API

Assets are static game items — weapons, props, effects, items — that can be saved to your library, animated, or turned into 3D models. Use the Assets API to programmatically generate them from prompts or upload your own.

List Assets

GET /api/v1/assets

Returns a paginated list of your assets.

Query Parameters

Response

{
  "assets": [
    {
      "id": "asset_abc123",
      "name": "Flaming Sword",
      "assetDescription": "A blade of pure fire",
      "folderId": "folder_xyz",
      "baseImageUrl": "https://...",
      "thumbnailUrl": "https://...",
      "createdAt": "2025-01-15T10:30:00Z"
    }
  ],
  "nextCursor": "asset_xyz789",
  "hasMore": true
}

Example

curl "https://www.autosprite.io/api/v1/assets?limit=10" \
  -H "x-api-key: vspk_your_key_here"

Create an Asset

POST /api/v1/assets

Create an asset by uploading an image or generating one from a text prompt.

Option 1: Upload Image File

Upload your own asset image. No credits required (paid plan still required).

curl -X POST https://www.autosprite.io/api/v1/assets \
  -H "x-api-key: vspk_your_key_here" \
  -F "name=Iron Shield" \
  -F "image=@./shield.png"

Option 2: Generate from Prompt

Generate an asset image using AI. Cost depends on the quality tier (see below).

curl -X POST https://www.autosprite.io/api/v1/assets \
  -H "x-api-key: vspk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Flaming Sword",
    "prompt": "a pixel art flaming sword with a ruby hilt"
  }'

Quality Tiers

Use ultra when you need sharper detail, more accurate structure, or when turbo gave you a mushy result. Both modes are synchronous — the response returns once the asset is created and saved.

# Generate with ultra quality (1 credit, slower, sharper)
curl -X POST https://www.autosprite.io/api/v1/assets \
  -H "x-api-key: vspk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Flaming Sword",
    "prompt": "a detailed flaming sword with ornate gold filigree and a glowing ruby hilt",
    "quality": "ultra"
  }'

Pixel Art

Set pixelArt: true for the same result as the Pixel art toggle in the web app: a 16-bit item sprite on a white background, snapped to a crisp pixel grid and a 32-colour palette. Always rendered at ultra (1 credit).

# Generate a pixel-art asset (1 credit)
curl -X POST https://www.autosprite.io/api/v1/assets \
  -H "x-api-key: vspk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Flaming Sword",
    "prompt": "a flaming sword with a ruby hilt",
    "pixelArt": true
  }'

Response (Both Modes)

Status: 201 Created

{
  "id": "asset_abc123",
  "name": "Flaming Sword",
  "assetDescription": null,
  "folderId": "folder_default",
  "baseImageUrl": "https://...",
  "thumbnailUrl": "https://...",
  "createdAt": "2025-01-15T10:30:00Z",
  "quality": "ultra"
}

The quality field is null for uploaded assets and "turbo" or "ultra" for generated ones.

Errors