Character Management

Manage your character collection — create, read, update, delete, tag, and export characters.

Endpoints

Operation	Method	Endpoint
List characters	`GET`	`/api/characters`
Show character	`GET`	`/api/characters/\{id\}`
Update character	`PUT`	`/api/characters/\{id\}`
Delete character	`DELETE`	`/api/characters/\{id\}`
Export as ZIP	`GET`	`/api/characters/\{id\}/export-zip`

Update Character

Parameters

Name	Type	Required	Description
`name`	string	No	Character name
`description`	string	No	Character description
`tags`	array	No	Array of tag strings
`thumbnail_asset_id`	string	No	Asset ID to use as thumbnail
`project_id`	string	No	Project to assign character to

Example

curl -X PUT https://api.spritesynth.com/api/characters/chr_xyz \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Dark Knight",
    "tags": ["warrior", "dark", "melee"],
    "project_id": "proj_123"
  }'

Export as ZIP

Download all character assets (sprite sheets, states, metadata) as a single ZIP file.

curl -X GET https://api.spritesynth.com/api/characters/chr_xyz/export-zip \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --output character_export.zip

ZIP Contents

character_export/
├── metadata.json
├── states/
│   ├── idle_south.png
│   ├── walk_south.png
│   └── attack_south.png
└── sprite_sheets/
    └── full_sheet.png

Tips

Use tags to organize characters by game, style, or type.
Set a thumbnail for quick identification in lists.
Export ZIP includes metadata.json compatible with Unity, Godot, and Aseprite.

Need help?

Join our Discord community for support and tips.

Character Management

On this page