VFX Studio

Export a transparent VFX pack (2 credits, idempotent request ID)

post/v1/vfx

Request

  • Base URL: https://api.sprixen.com
  • URL: https://api.sprixen.com/v1/vfx
  • Auth: bearer (a scheme the document does not define)

Request body

requestIdstring uuid required

Keep this UUID for identical retries to avoid duplicate charges.

namestring required
preset'portal' | 'aura' | 'shield' | 'burst' | 'beam' | 'hazard' | 'flame' | 'fireball' | 'firewall' | 'frost' | 'icestorm' | 'snow' | 'lightning' | 'chainlightning' | 'thunder' | 'waterwave' | 'whirlpool' | 'rain' | 'smoke' | 'fog' | 'poison' | 'acid' | 'healing' | 'blessing' | 'leaves' | 'vines' | 'runes' | 'summoning' | 'blackhole' | 'stars' | 'meteor' | 'slash' | 'claw' | 'shockwave' | 'shatter' | 'confetti'

v1 legacy preset. Omit and use family for v2.

colorstring
accentstring
family'fireball' | 'fire-bolt' | 'burning-hands' | 'flame-wall' | 'meteor' | 'ray-of-frost' | 'ice-storm' | 'frost-nova' | 'lightning-bolt' | 'chain-lightning' | 'shock' | 'magic-missile' | 'shield-ward' | 'arcane-portal' | 'eldritch-blast' | 'dispel-magic' | 'cure-wounds' | 'bless-aura' | 'spirit-guardians' | 'inflict-wounds' | 'hunger-of-hadar' | 'necrotic-burst' | 'entangle' | 'thorn-whip' | 'poison-spray' | 'slash' | 'thrust' | 'hit-spark' | 'block' | 'critical-hit' | 'rain' | 'snow' | 'fog' | 'embers' | 'dust' | 'level-up' | 'coin-burst' | 'checkpoint' | 'heal-pop' | 'shield-break'

v2 effect family slug. Presence of this field selects the v2 recipe.

fps12 | 24
loopboolean

Overrides the family's default loop/one-shot behavior.

projectIdstring

Project that owns the reference sprite. Enables style lock.

spriteIdstring

Reference sprite in that project to match the effect's look to.

aiStyleLockboolean

+2 credits. Requires projectId/spriteId. Generates AI particle textures matched to the sprite; falls back to no-AI style lock and refunds on failure.

sfxboolean

+1 credit. Pairs a short procedural sound effect with the export.

intensitynumber required
seednumber required
duration1 | 2 | 4 required

v1 only accepts 2 or 4.

size256 | 512 | 1024 required

v1 only accepts 256 or 512.

Example request

{
  "color": "#a78bfa",
  "accent": "#67e8f9",
  "palette": {
    "main": "#ff6a1f",
    "accent": "#ffd23f",
    "glow": "#fff2c2"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.