S
spritesynthDOCS

Tileset Management

CRUD operations, project assignment, and ZIP export for tilesets.

Tileset Management

Manage your tileset collection — create, read, update, delete, assign to projects, and export.

Endpoints

OperationMethodEndpoint
List tilesetsGET/api/tilesets
Show tilesetGET/api/tilesets/\{id\}
Update tilesetPUT/api/tilesets/\{id\}
Delete tilesetDELETE/api/tilesets/\{id\}
Export as ZIPGET/api/tilesets/\{id\}/export-zip

Update Tileset

Parameters

NameTypeRequiredDescription
namestringNoTileset name
descriptionstringNoTileset description
typestringNoType: top_down, sidescroller, isometric
project_idstringNoProject to assign tileset to

Example

curl -X PUT https://api.spritesynth.com/api/tilesets/ts_xyz \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Dungeon Floor Set",
    "description": "Stone and dirt tiles for dungeon environments",
    "project_id": "proj_123"
  }'

Export as ZIP

Download tileset assets as a single ZIP file for use in game engines.

curl -X GET https://api.spritesynth.com/api/tilesets/ts_xyz/export-zip \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --output tileset_export.zip

ZIP Contents

tileset_export/
├── metadata.json
├── tiles/
│   ├── inner_001.png
│   ├── inner_002.png
│   └── outer_001.png
├── atlas.json
└── tiled/
    └── tileset.tsj

Tips

  • Assign tilesets to projects to keep related assets organized.
  • Export includes Tiled-compatible JSON for direct import.
  • Use the atlas.json for custom engine integrations.

Need help?

Join our Discord community for support and tips.
Was this page helpful?

On this page