spritefusion-com API

openapi: 3.1.0
info:
  title: spritefusion-com API
  version: '2026-10-31'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-31: 19 operation(s) read from 8 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; spritefusion-com has published no machine-readable contract that
    the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 9
    documentation: 10
    pages-with-code: 7
    pages-read: 8
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-31'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://www.spritefusion.com/docs/pixel-art-generator/api
  - https://www.spritefusion.com/docs/pixel-art-generator/api/codex
  - https://www.spritefusion.com/docs/pixel-art-generator/api/agent-guide
  - https://www.spritefusion.com/docs/pixel-art-generator/api/claude-code
  - https://www.spritefusion.com/docs/pixel-art-generator/api/api-reference
  - https://www.spritefusion.com/docs/pixel-art-generator/api/streaming-errors-and-credits
  - https://www.spritefusion.com/docs/pixel-art-generator/api/generate-and-transform-images
  - https://www.spritefusion.com/docs/pixel-art-generator/api/input-images-and-temporary-uploads
paths:
  /api/v1/assets:
    get:
      operationId: get_api_v1_assets
      tags:
      - Api
      summary: GET /api/v1/assets
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/api-reference
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1AssetsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -sS 'https://www.spritefusion.com/api/v1/assets?limit=10'  -H \"Authorization: Bearer $SPRITE_FUSION_API_KEY \" \n limit\
          \ is optional: 1–100 assets, default 20. Batch members count individually, retain their batch metadata, and may span pages. \n tag is\
          \ optional: only assets with that tag are listed, for example ?tag=weapons . \n Returns assets , hasMore , and nextCursor . Start without\
          \ a cursor . "
  /api/v1/assets/asset_:
    patch:
      operationId: patch_api_v1_assets_asset
      tags:
      - Api
      summary: PATCH /api/v1/assets/asset_
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/api-reference
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiV1AssetsAssetRequest'
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchApiV1AssetsAssetResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -sS -X PATCH https://www.spritefusion.com/api/v1/assets/asset_...  -H \"Authorization: Bearer $SPRITE_FUSION_API_KEY \"\
          \  -H \"Content-Type: application/json\"  --data '{\"tags\":[\"dungeon-crawler\",\"weapons\"]}' \n An asset has up to 10 tags. Each\
          \ is 1–32 letters, numbers, spaces, hyphens, or underscores, and is stored trimmed and lowercase. The basic, recommended tag is the\
          \ game or project name. \n GE"
  /api/v1/credits:
    get:
      operationId: get_api_v1_credits
      tags:
      - Api
      summary: GET /api/v1/credits
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1CreditsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://www.spritefusion.com/api/v1/credits  -H \"Authorization: Bearer $SPRITE_FUSION_API_KEY \" \n The response is ordinary\
          \ JSON: \n { \"credits\" : 285 } \n Keep keys private \n Never embed an API key in a browser bundle, game, plugin distributed to players,\
          \ public repository, URL, log, or analytics event. \n If a key is exposed, revoke it from the account page and create a replacement.\
          \ \n Available"
  /api/v1/generate:
    post:
      operationId: post_api_v1_generate
      tags:
      - Api
      summary: POST /api/v1/generate
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/codex
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1GenerateRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -sS -N https://www.spritefusion.com/api/v1/generate  -H "Authorization: Bearer $SPRITE_FUSION_API_KEY "  -H "Content-Type:
          application/json"  --data ''{"operation":"generate","prompt":"A brass dungeon key","size":32}''  > /tmp/spritefusion-events.txt Need
          Help? Join the Discord MCP Server Connect Claude, ChatGPT, Codex, Cursor, VS Code, and other MCP clients to Sprite Fusion to generate,
          edit, '
  /api/v1/normal-maps:
    post:
      operationId: post_api_v1_normal_maps
      tags:
      - Api
      summary: POST /api/v1/normal-maps
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/generate-and-transform-images
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1NormalMapsRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1NormalMapsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -sS --fail-with-body https://www.spritefusion.com/api/v1/normal-maps  -H \"Authorization: Bearer $SPRITE_FUSION_API_KEY\
          \ \"  -H \"Content-Type: application/json\"  --data '{\"inputs\":[{\"asset_id\":\"hero\"}]}'  -o hero_n.png \n See Generate Normal Maps\
          \ to use it in Godot and Unity. \n Tag results \n Every operation accepts optional tags , saved on each output. The basic, recommended\
          \ tag is the game or pr"
  /api/v1/tags:
    get:
      operationId: get_api_v1_tags
      tags:
      - Api
      summary: GET /api/v1/tags
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/api-reference
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1TagsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -sS https://www.spritefusion.com/api/v1/tags  -H \"Authorization: Bearer $SPRITE_FUSION_API_KEY \" \n { \"tags\" :[{ \"\
          name\" : \"weapons\" , \"count\" : 12 },{ \"name\" : \"dungeon\" , \"count\" : 5 }]} \n GET /vfx-library \n Lists the open source pixel\
          \ art VFX library: every effect with its category, a one-line description, and its situations with animated previews. Free. "
  /api/v1/uploads:
    post:
      operationId: post_api_v1_uploads
      tags:
      - Api
      summary: POST /api/v1/uploads
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/input-images-and-temporary-uploads
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -sS https://www.spritefusion.com/api/v1/uploads  -H \"Authorization: Bearer $SPRITE_FUSION_API_KEY \"  -H \"Content-Type:\
          \ application/json\"  --data \"{ \\\" content_type \\\" : \\\" image/png \\\" , \\\" size_bytes \\\" : $SIZE_BYTES , \\\" sha256 \\\"\
          \ : \\\" $SHA256 \\\" }\"  > upload.json \n The response includes upload_id , upload_url , upload_url_expires_at , upload_id_expires_at\
          \ , and the exact required headers. "
  /api/v1/vfx-library:
    get:
      operationId: get_api_v1_vfx_library
      tags:
      - Api
      summary: GET /api/v1/vfx-library
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/api-reference
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1VfxLibraryResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -sS https://www.spritefusion.com/api/v1/vfx-library  -H \"Authorization: Bearer $SPRITE_FUSION_API_KEY \" \n { \"effects\"\
          \ :[{ \"slug\" : \"ice\" , \"title\" : \"Ice\" , \"category\" : \"Elements\" , \"description\" : \"Spikes, a frost nova, crystals, shattering\
          \ blocks, frozen characters.\" , \"situations\" :[{ \"name\" : \"Nova\" , \"preview\" : \"https://www.spritefusion.com/images/pixel-art-vfx/ice-nova.webp\"\
          \ }]}]} \n G"
  /api/v1/vfx-library/ice:
    get:
      operationId: get_api_v1_vfx_library_ice
      tags:
      - Api
      summary: GET /api/v1/vfx-library/ice
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/api-reference
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1VfxLibraryIceResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -sS https://www.spritefusion.com/api/v1/vfx-library/ice  -H \"Authorization: Bearer $SPRITE_FUSION_API_KEY \" \n Unknown\
          \ slugs return 404 with the vfx_not_found code. \n POST /uploads \n Creates a short-lived upload URL for an input image. Send JSON with\
          \ these fields: \n Field Type Description content_type string image/png , image/jpeg , or image/webp size_bytes integer Exact file size,\
          \ up to 20 Mi"
  /assets:
    get:
      operationId: get_assets
      tags:
      - Assets
      summary: Find saved results.
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/agent-guide
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      - name: tag
        in: query
        required: false
        schema:
          type: string
      - name: nextCursor
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /assets/{assetid}:
    get:
      operationId: get_assets_assetid
      tags:
      - Assets
      summary: Retrieve a saved asset by ID.
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/agent-guide
      parameters:
      - name: assetid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_assets_assetid
      tags:
      - Assets
      summary: Replace an asset's tags.
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/agent-guide
      parameters:
      - name: assetid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /credits:
    get:
      operationId: get_credits
      tags:
      - Credits
      summary: Return the current credit total.
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCreditsResponse'
      x-evidence:
        kind: documentation
  /generate:
    post:
      operationId: post_generate
      tags:
      - Generate
      summary: Accept all five generation operations and stream Server-Sent Events.
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /normal-maps:
    post:
      operationId: post_normal_maps
      tags:
      - Normal Maps
      summary: Return the normal map PNG of a sprite or animation, for free.
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /tags:
    get:
      operationId: get_tags
      tags:
      - Tags
      summary: Check existing tags to reuse rather than creating near-duplicates.
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/agent-guide
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /uploads:
    post:
      operationId: post_uploads
      tags:
      - Uploads
      summary: Issue a short-lived direct upload URL for a large private input.
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /vfx-library:
    get:
      operationId: get_vfx_library
      tags:
      - Vfx Library
      summary: List the free library of pixel art VFX effects.
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/agent-guide
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /vfx-library/{slug}:
    get:
      operationId: get_vfx_library_slug
      tags:
      - Vfx Library
      summary: Get a pixel art VFX effect by slug.
      x-source: https://www.spritefusion.com/docs/pixel-art-generator/api/agent-guide
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiV1AssetsResponse:
      type: object
      properties:
        asset:
          type: object
    PatchApiV1AssetsAssetRequest:
      type: object
      properties:
        tags:
          type: array
          items:
            type: string
    PatchApiV1AssetsAssetResponse:
      type: object
      properties:
        tags:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              count:
                type: integer
    GetApiV1CreditsResponse:
      type: object
      properties:
        credits:
          type: integer
    PostApiV1GenerateRequest:
      type: object
      properties:
        operation:
          type: string
        prompt:
          type: string
        size:
          type: integer
    PostApiV1NormalMapsRequest:
      type: object
      properties:
        inputs:
          type: array
          items:
            type: object
            properties:
              asset_id:
                type: string
    PostApiV1NormalMapsResponse:
      type: object
      properties:
        operation:
          type: string
        prompt:
          type: string
        size:
          type: integer
        tags:
          type: array
          items:
            type: string
    GetApiV1TagsResponse:
      type: object
      properties:
        tags:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              count:
                type: integer
    GetApiV1VfxLibraryResponse:
      type: object
      properties:
        vfx:
          type: object
    GetApiV1VfxLibraryIceResponse:
      type: object
      properties:
        upload_id:
          type: string
        upload_url:
          type: string
        upload_url_expires_at:
          type: string
          format: date-time
        upload_id_expires_at:
          type: string
          format: date-time
        headers:
          type: object
          properties:
            Content-Type:
              type: string
    GetCreditsResponse:
      type: object
      properties:
        credits:
          type: integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Assets
- name: Credits
- name: Generate
- name: Normal Maps
- name: Tags
- name: Uploads
- name: Vfx Library