Direction sprites

What you can create

Generate a coordinated four-direction or eight-direction character view set from a single image. Use it to establish consistent appearances before directional animations. A successful result includes ready image assets; inspect each view before reuse.

Prepare the source

Choose one full-body character with a clear silhouette. The source can be an upload or a prior generated image. directions must be 4 or 8. cameraPerspective defaults to auto; an optional prompt can preserve distinctive equipment or proportions.

Generate views in the workspace

1. Open Direction sprite generator.
2. Choose the source character, four or eight directions and the camera perspective.
3. Add any important visual constraints and select a project or compatible character destination.
4. Review the cost, generate, then compare the views for consistency.

Choices, limits and cost

Both four and eight directions cost 5 credits per generation. When archiving under a character, select its current design and matching direction mode. An existing direction generation may be reused or reported as a conflict to avoid duplicate charges. If the character design changes, refresh its details before submitting.

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 5 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_direction_sprites",
9  "input": {
10    "inputAssetId": "00000000-0000-4000-8000-000000000001",
11    "directions": 4
12  }
13}
14JSON
15
16curl --fail-with-body "$BASE_URL/api/v1/estimates" \
17  -H "Authorization: Bearer $SPRITEFLOW_API_KEY" \
18  -H "Content-Type: application/json" --data-binary @request.json
19
20curl --fail-with-body "$BASE_URL/api/v1/tasks" \
21  -H "Authorization: Bearer $SPRITEFLOW_API_KEY" \
22  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
23  -H "Content-Type: application/json" --data-binary @request.json
24

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_direction_sprites. The following is a tools/call params object:

1{
2  "name": "generate_direction_sprites",
3  "arguments": {
4    "input": {
5      "inputAssetId": "00000000-0000-4000-8000-000000000001",
6      "directions": 4
7    },
8    "idempotencyKey": "example-workflow-001"
9  }
10}

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