API quickstart | Sprite Flow Docs

Prerequisites

Sign in to your own account and create a key in API & MCP settings. For this tutorial enable tasks:read, tasks:write, credits:read and downloads:read. Add uploads:write if you need to upload images. Save the displayed key securely: plaintext is shown once.

Set the key in your shell without putting it in a URL. All requests in one workflow must use the same deployment and account.

bash

1BASE_URL="https://spriteflow.io"
2read -rs SPRITEFLOW_API_KEY
3export SPRITEFLOW_API_KEY

Discover and estimate

bash

1curl --fail-with-body "$BASE_URL/api/v1/capabilities" \
2  -H "Authorization: Bearer $SPRITEFLOW_API_KEY"
3curl --fail-with-body "$BASE_URL/api/v1/credits" \
4  -H "Authorization: Bearer $SPRITEFLOW_API_KEY"

Capabilities lists operations, input Schemas, documentation links and business options. Choose Character design, copy its request JSON and call POST /api/v1/estimates before generation. Estimation validates parameters and reports credits but neither reserves balance nor creates a task.

Submit once

Submit that JSON to POST /api/v1/tasks with a unique Idempotency-Key. The request shape is {operation, input, webhookUrl?}. Keep both the body and key until the task finishes. HTTP 202 means accepted, with taskId, statusUrl and pollAfterSeconds.

bash

1curl --fail-with-body "$BASE_URL/api/v1/tasks" \
2  -H "Authorization: Bearer $SPRITEFLOW_API_KEY" \
3  -H "Idempotency-Key: character-ranger-001" \
4  -H "Content-Type: application/json" --data-binary @request.json

Poll and use the result

bash

1TASK_ID="replace-with-returned-task-id"
2curl --fail-with-body "$BASE_URL/api/v1/tasks/$TASK_ID" \
3  -H "Authorization: Bearer $SPRITEFLOW_API_KEY"
4ASSET_ID="replace-with-returned-asset-id"
5curl --fail-with-body "$BASE_URL/api/v1/assets/$ASSET_ID/download" \
6  -H "Authorization: Bearer $SPRITEFLOW_API_KEY"

Wait at least the recommended interval between polls. When terminal is true, inspect the overall state and every item. Download a successful asset from the returned temporary URL, or pass its ID into Pro animation as inputAssetId with a new idempotency key.

Handle a lost response

Repeat the identical submission with its original key. A replay returns the original task and does not charge again. If parameters change, use a new key only for an intentional new generation. See Idempotency.

Machine-readable references

Public endpoints provide OpenAPI, the document index and English Markdown at /api/docs/markdown?page=<article-slug>. No sign-in or Bearer key is needed to read them; API business operations still require your scoped key.