Version History & Asset Rollback

Overview

Pixel art is iterative. You'll tweak a sprite, decide the old version was better, then wish you could go back. spritesynth's version system lets you create snapshots of any asset at key milestones — before a big edit, after a generation you like, or at the end of each session. You can restore any previous version at any time.

Step 1: Create a Version Snapshot

Before making significant changes to an asset, save a snapshot:

curl -X POST https://api.spritesynth.com/v1/assets/{asset_id}/versions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "label": "Pre-palette-swap backup",
      "session": "2025-06-09"
    }
  }'

The snapshot captures the current state of the asset. Add descriptive labels in metadata so you can identify each version later.

Step 2: List Version History

View all snapshots for an asset to find the one you need:

curl https://api.spritesynth.com/v1/assets/{asset_id}/versions \
  -H "Authorization: Bearer YOUR_API_KEY"

The response includes each version's number, timestamp, file size, and the metadata labels you provided. Versions are sorted newest-first.

Step 3: Restore a Previous Version

Found the version you want? Restore it:

curl -X POST https://api.spritesynth.com/v1/assets/{asset_id}/versions/{version_id}/restore \
  -H "Authorization: Bearer YOUR_API_KEY"

Restore creates a new version — the current state is preserved as the latest snapshot before rollback. You can always undo a restore by restoring forward again.

Example: Iterative Design Workflow

1. Generate a character → auto-snapshot created
2. Edit colors in the editor → create a manual snapshot: "post-color-adjust"
3. Run image-to-pixel conversion → create snapshot: "post-to-pixel"
4. Decide the original was better → restore version 1
5. All intermediate states are preserved in history

Tips

• Snapshot before risky edits — Palette swaps, inpaint operations, and high-resolution upscales are good candidates for pre-edit snapshots.
• Label meaningfully — "before-inpaint" is more useful than "v1" when you're scanning 20 versions.
• Session-based snapshots — Create a snapshot at the end of each work session: "2025-06-09-session-end".
• Version count — There's no hard limit, but aim for 10-20 significant snapshots per asset. Delete intermediate snapshots if cleanup is needed.
• Combine with project export — Export your entire project as ZIP alongside version snapshots for a complete backup strategy.