S
spritesynthDOCS

General Options

Shared options across all generation and editing tools.

General Options

These options are shared across most generation and editing tools. They control output behavior, canvas settings, and processing preferences.

Parameters

NameTypeRequiredDescription
seedintegerNoRandom seed for reproducible results. 0 = random. Default: 0
output_methodstringNoWhere to place output. Default: new_layer
tile_sizestringNoTile dimensions for tileset generation. Options: 16x16, 32x32, 48x48, 64x64
remove_backgroundbooleanNoAutomatically remove background from output. Default: false
force_symmetrybooleanNoForce horizontal symmetry in output. Default: false

Output Method

Controls where generated content is placed in the editor:

ValueDescription
new_layerCreate a new layer with the generated content
modify_layerReplace content on the active layer
new_frameAdd a new animation frame with the generated content

Seed

The seed value controls randomness:

  • 0 — Random seed, each generation produces a different result
  • Any positive integer — Fixed seed, same prompt + seed = same output
  • Use seeds for reproducible A/B testing and batch generation

Example

curl -X POST https://api.spritesynth.com/api/generations/image \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "a pixel art tree",
    "seed": 42,
    "remove_background": true
  }'

Tips

  • Use seed to reproduce promising results exactly.
  • remove_background: true saves a manual step for sprite isolation.
  • force_symmetry is useful for characters and faces.

Need help?

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

On this page