Build with AutoSprite 3.0
Make your first request
Use your Sorceress API key on your server. The playground uses your signed-in account; your application uses the same model with an API key.
curl -X POST 'https://sorceress.games/api/v1/tools/autosprite_animate' \
-H 'Authorization: Bearer $SORCERESS_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"characterAssetId": "<characterAssetId>",
"animations": "<animations>"
}'Inputs & settings
startPoseIdstringSaved pose ID from get_character or create_start_pose. Default original. Can be overridden per animations[] item; all pose IDs are validated before any generation starts.
characterAssetIdstringRequiredCharacter asset id from autosprite_create_character (or the V3 UI).
animationsarrayRequiredArray of { label, prompt, duration?, startPoseId? }. Duration seconds 2–10 (default 5). The agent writes the prompts — no separate "generate prompts" step.
resolutionstring720p (default) or 1080p where the model supports it.
Full input schema
{
"required": [
"characterAssetId",
"animations"
],
"properties": {
"startPoseId": {
"type": "string",
"title": "start Pose Id",
"description": "Saved pose ID from get_character or create_start_pose. Default original. Can be overridden per animations[] item; all pose IDs are validated before any generation starts."
},
"characterAssetId": {
"type": "string",
"title": "character Asset Id",
"description": "Character asset id from autosprite_create_character (or the V3 UI)."
},
"animations": {
"type": "array",
"title": "animations",
"description": "Array of { label, prompt, duration?, startPoseId? }. Duration seconds 2–10 (default 5). The agent writes the prompts — no separate \"generate prompts\" step."
},
"resolution": {
"type": "string",
"title": "resolution",
"description": "720p (default) or 1080p where the model supports it."
}
}
}Workflow actions
Capture a source-video frame or calibrate a canvas without resizing the character. Saves a reusable pose under the same character Job ID. Free. 4:5 taller canvas defaults to upward padding.
AutoSprite · Inspect FramesReview numbered source-video or sheet frames. Returns contact-sheet image URL, coordinate space, blank/edge heuristics. Free; visual judgment is required for airborne poses and clipped limbs.
AutoSprite · Save Frame TagsSave sparse ordered frame sections and per-tag timing in the same analyzer as the website. Requires current sheet URL and analyzer revision; preserves other metadata. Free; dryRun validates only.
AutoSprite · ListList AutoSprite V3 workspaces and assets (characters + animations). Assets come from ONE workspace per call (default workspace unless workspaceId is passed) — for an asset by ID from any workspace use autosprite_get_character instead of re-listing. Returns HD mediaUrl / spriteSheetUrl only — not gallery hover thumbnails. Synchronous.
AutoSprite · Create CharacterSave a character image into AutoSprite V3 (usually the result of image_generate on a chroma screen — green is the usual generate default; blue also keys). Synchronous — returns assetId for autosprite_animate.
AutoSprite · Get Character PackLoad AutoSprite V3 by ID. Character Job ID (gallery card) → full character + all animations. Animation Anim ID (Animate Studio clip card) → that one clip with HD spriteSheetUrl, keyed sheets, and sprite-analyzer/tag config. Synchronous. Prefer when a human hands an ID from /autosprite-v3 to a coding agent. For clip-aligned SFX, follow with autosprite_get_sounds or video_extract_audio.
AutoSprite · Get Animation SoundsExtract MP3 soundtracks from AutoSprite V3 animations (same baked-in SFX as Animate Studio "Sounds" / Full pack). Pass character jobId for the whole pack, or assetIds[] for a subset. Free / sync / cached. Large packs may return partial:true — call again with the same input until partial is false (done clips are instant). Prefer these clip-aligned sounds over generating new SFX unless the user asks.
AutoSprite · AnimateGenerate image-to-video animations for a V3 character (raw chroma-screen MP4s). Async — poll GET /api/v1/jobs/:id to finalize (provider runs in the background; poll does not push frames). On failed/Internal Error, retry animate — do not keep polling a dead jobId. DEFAULT NEXT STEP after each video succeeds: autosprite_key → keep polling until keyed sheet is ready.
AutoSprite · Corridor KeyCorridor Key green/blue-screen removal for AutoSprite V3 animation videos via Sorceress cloud GPU. DEFAULT after autosprite_animate. Pass assetId (or assetIds[]). keyColor "auto" detects green or blue. Already-keyed clips are returned instantly in alreadyKeyed[] with their existing spriteSheetUrl (no job, no charge) — pass force:true to re-key. Async CHUNKED WORKER — each poll advances only a few frames; you MUST keep polling until succeeded or the sheet never lands. For FREE local GPU keying, start sorcgcs-server and use WizardGenie backend:"local", or key yourself then call autosprite_attach_keyed (see tool notes).
AutoSprite · Attach Keyed SheetSave a pre-keyed transparent sprite sheet onto an AutoSprite V3 animation (same gallery KEYED state as cloud Corridor Key). Free / sync. Use after local Corridor Key (sorcgcs-server on :8100): file_upload the PNG, then attach with grid meta. WizardGenie sorceress_autosprite_key backend:"local" does this end-to-end.
Corridor Key · Still ImageCorridor Key green/blue-screen removal for any still image. Pass imageUrl, poll until succeeded, use transparentUrl. Same cloud GPU as /corridor-chroma. keyColor "auto" detects the plate. For AutoSprite videos use autosprite_key; for Parallax layers you may use this or parallax_key. Async — poll GET /api/v1/jobs/:id.
Results, saved runs & billing
Media requests return a job ID. Poll GET /api/v1/jobs/:id until it succeeds or fails; keep the same ID while it is processing. Long chat requests can also return a saved job to poll. Completed outputs are stored in your account, and successful work is billed using your model's current rates.
A multi-step workflow may include separately billed successful actions. If a connection drops, check your saved run before submitting it again.
