Pro animation

What you can create

Use Pro to turn one character image into a 32-frame animation. It suits expressive movement and longer motion than a compact Classic sequence. Example: animate a ranger walking in place while preserving the source costume.

Prepare the character

Use one full-body ready image with visible hands and feet and enough empty space for motion. Transparent PNG is useful; PNG, JPEG and WebP inputs are supported. Reuse a Character design result or confirm a new upload. Do not use an entire four-view sheet as a single-pose input.

Animate in the workspace

1. Open Sprite Motion, choose Pro and select the image.
2. Describe the action, direction and important constraints in plain language.
3. Keep 32 frames and 8 FPS. Configure the available background and loop options.
4. Review the 10-credit cost and destination, then generate.
5. Inspect playback and available export files when the task is complete.

Choices, limits and cost

Pro costs 10 credits and requires exactly 32 frames at 8 FPS. Omitting frameCount and fps supplies those defaults. Explicit incompatible values are rejected. loop is available for standalone Pro generation; character action generation does not accept it. Existing download rights remain applicable.

For clipped motion, inspect the source padding and simplify the action before intentionally starting a new generation. A timeout is not evidence of a failed task: keep its idempotency key and query the original task.

Parameters

These fields are generated from the same input Schema used by REST and MCP. Nested required fields apply when their parent object or selected variant is present. Business conditions described above are validated before submission.

API example

This example costs 10 credits. A quote does not reserve balance or bypass subscription requirements. Set SPRITEFLOW_API_KEY in your shell. Replace the placeholder asset ID 00000000-0000-4000-8000-000000000001 with a ready asset you own when present. Use a new idempotency key for each intentional generation; keep it unchanged when retrying.

1
2# Use the same BASE_URL for credentials, uploads and generation.
3BASE_URL="https://spriteflow.io"
4IDEMPOTENCY_KEY="example-workflow-001"
5
6cat > request.json <<'JSON'
7{
8  "operation": "generate_sprite_motion",
9  "input": {
10    "inputAssetId": "00000000-0000-4000-8000-000000000001",
11    "mode": "pro",
12    "prompt": "Walk in place, facing right"
13  }
14}
15JSON
16
17curl --fail-with-body "$BASE_URL/api/v1/estimates" \
18  -H "Authorization: Bearer $SPRITEFLOW_API_KEY" \
19  -H "Content-Type: application/json" --data-binary @request.json
20
21curl --fail-with-body "$BASE_URL/api/v1/tasks" \
22  -H "Authorization: Bearer $SPRITEFLOW_API_KEY" \
23  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
24  -H "Content-Type: application/json" --data-binary @request.json
25

An accepted request returns HTTP 202, Location and Retry-After headers. Example response (IDs are illustrative):

1{"taskId":"00000000-0000-4000-8000-000000000002","status":"accepted","statusUrl":"/api/v1/tasks/00000000-0000-4000-8000-000000000002","pollAfterSeconds":10,"replayed":false}

MCP example

Call estimate_cost with the same operation and input, then call generate_sprite_motion. The following is a tools/call params object:

1{
2  "name": "generate_sprite_motion",
3  "arguments": {
4    "input": {
5      "inputAssetId": "00000000-0000-4000-8000-000000000001",
6      "mode": "pro",
7      "prompt": "Walk in place, facing right"
8    },
9    "idempotencyKey": "example-workflow-001"
10  }
11}

The tool returns the same task receipt in structuredContent and a JSON text result. Pass taskId to get_task. Tool annotations describe behavior; permissions are still checked on the server.

Completion, download and reuse

Poll the returned statusUrl after pollAfterSeconds. Continue while terminal is false. Read items for per-task results, progress for batch counts and assets for ready files. A batch can be partially_completed: use its successful assets and review each failed item before deciding whether to create a separate retry.

For each returned asset ID, call get_download_url or GET /api/v1/assets/{assetId}/download. Download the temporary URL before it expires. Image assets can be passed into a compatible operation as inputAssetId or a style reference. Do not pass provider task IDs, download URLs or local filesystem paths as asset IDs.

Failures and recovery

• INVALID_PARAMETERS: fix the field errors before submitting. Check the business conditions and defaults above.
• INPUT_ASSET_UNAVAILABLE: confirm the upload, check ownership and ensure the asset is ready and not trashed.
• INSUFFICIENT_CREDITS: add credits before a new request; a cost estimate does not reserve them.
• A timeout or lost response: resend the identical request with the original idempotency key. Never invent a new key just because the response was lost.
• A terminal generation failure: inspect the item error and refund information. Refund handling uses the existing generation workflow. Do not assume an in-progress or unknown submission is safe to repeat.

Related guides

Uploads · Tasks · Credits · Idempotency · Save destinations · Download and export