Export formats

An export renders a mascot (and, for animated formats, one of its animations) to a file. Exports are jobs because video encoding takes a few seconds, but they never call a model and never cost credits. Vector formats come straight from the rig, so they stay sharp at any size and weigh kilobytes.

Formats#

Animated#

These need an animation: an animation id, an animation name, or any preset id such as wave (presets are fitted to the rig on the fly, even if you never saved one).

Stills#

animation is optional here: with it, the still is posed at time t of that animation; without it you get the rest pose.

Export options#

POST/mascots/{id}/exports

curl -X POST https://lumorig.com/api/v1/mascots/msc_…/exports -H "Authorization: Bearer $LUMORIG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "format": "webm", "animation": "wave", "size": 768, "fps": 30 }'
# 202 → { "id": "job_…", "type": "export", "status": "queued", … }

curl "https://lumorig.com/api/v1/jobs/job_…?wait=60" -H "Authorization: Bearer $LUMORIG_API_KEY"
# → { "status": "succeeded", "result": { "file": { "id": "file_…", "url": "/api/v1/files/file_…", "mime": "video/webm", "bytes": … } } }

Downloading files#

A finished export job has result.file. Its url is relative to the API origin and, like every file endpoint, needs your API key.

GET/files/{id}

curl -L "https://lumorig.com/api/v1/files/file_…?download=1" -H "Authorization: Bearer $LUMORIG_API_KEY" -o pip-wave.webm

Files are immutable, so responses carry a year-long private cache header. Store the bytes on your own CDN if you serve them to users.

Previews#

For thumbnails and quick checks there is a synchronous still renderer. It answers in the request (no job), works with an API key or, for public mascots, with no key at all.

GET/mascots/{id}/preview

<img src="https://lumorig.com/api/v1/mascots/msc_…/preview?animation=wave&t=0.6&size=256" alt="Pip waving" />

Choosing a format#

Measured on one character, a two-second wave at 30 fps and 512 px. Your numbers will vary with the drawing, but the ratios hold.