S
spritesynthAPI
spritesynth API v1

Welcome to the spritesynth API

The spritesynth REST API lets you integrate AI-powered pixel art generation into your game development workflow. Create characters, environments, animations, and UI elements programmatically.

Quick Start

1. Generate an API key from your dashboard

2. Send requests with your key in the Authorization: Bearer <key> header

3. Generate pixel art and download your assets

Authentication

  • API Keys
    All requests require an API key passed via the Authorization header. Generate keys from your spritesynth dashboard.

Image Generation

  • Text-to-Pixel-Art
    Generate pixel art from text prompts with model selection, style control, negative prompts, and seed support.
  • Style Reference
    Provide an image as style reference to guide the output aesthetic.
  • UI Elements
    Generate game UI elements — buttons, panels, icons, and HUD components.

Animation

  • Text-to-Animation
    Generate pixel art animations from text descriptions.
  • Skeleton Animation
    Animate sprites using AI-estimated skeleton rigs.
  • Interpolation
    Generate intermediate frames between keyframes.

Editing & Post-Processing

  • Inpainting
    Selectively regenerate parts of an image by masking areas.
  • Background Removal
    Remove backgrounds from generated or uploaded images.
  • Rotation
    Generate multi-angle views of characters and objects.
  • Resize & Convert
    Resize pixel art and convert regular images to pixel art style.

Tilesets & Maps

  • Tile Generation
    Create tilesets for top-down, sidescroller, and isometric games.
  • Map Objects
    Generate individual game objects for placement on maps.

Character Pipeline

  • Character Creation
    Create multi-directional characters with AI-generated sprites.
  • State Management
    Add animation states (idle, walk, attack, etc.) to characters.
  • Export
    Export characters for Unity, Godot, Aseprite, and Tiled formats.

Resources

  • Client Libraries
    Python client library for programmatic access to the API.
  • REST API
    Full REST API with JSON request/response format.
  • API Limits
    Rate limits and credit costs vary by model and operation type.