Skip to article

API & MCP documentation

Integrate Sprite Flow through REST APIs and MCP. Generate game assets, estimate credits, reuse files and download results.

One workflow from idea to game asset

Choose a business, prepare its inputs, review credits, submit once, wait for completion and download or reuse the result. The web workspace, REST API and MCP share the same generation services, credit balance and download rights.

Documentation is public, including the Markdown index and OpenAPI specification. Sign in only when creating scoped API keys for your account or using account features. API and MCP calls use the key owner's credits, assets and download rights. Other application languages currently display these English articles.

Before automating a business, check GET /api/v1/capabilities or get_capabilities and require available: true. Business articles mark integrations that are still pending; their web workflows remain available.

Choose your starting point

GoalStart hereUseful next step
Design a new characterCharacter designPro animation
Animate an existing characterClassic or ProDownload and export
Create directional movementDirection spritesDirection animation
Populate a townBatch NPCSearch and reuse
Build an environmentMaps or TilesetsScene extraction
Create items and equipmentPropsCharacter assets
Add game audioMusic or Sound effectsDownload

Choose an interface

How the documentation is organized

Getting started contains tutorials. Business articles are task-oriented how-to guides. Asset workflows explain how results remain reusable. Integration reference documents the shared protocols, errors and permissions. Each page has a breadcrumb, an outline and Markdown copy/download actions; the left search searches article bodies as well as titles.

Understand the boundaries

The first release uses scoped Bearer keys over HTTP JSON. It supports selecting existing projects and compatible characters; it does not expose deletion, complete project management, version adoption or OAuth. Disabled pixel repair is not part of the integration.