Sprite AI Sprite AI API

openapi: 3.2.0
info:
  title: Sprite AI API
  version: '2026-10-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-11: 6 operation(s) read from 1 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Sprite AI has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 26
    documentation: -20
    pages-with-code: 1
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.sprite-ai.art/docs/api-reference
security:
- bearer: []
tags:
- name: Sprite AI API
paths:
  /api/{apiid}:
    get:
      operationId: get_api_apiid
      tags:
      - Sprite AI API
      summary: GET /api/animations
      x-source: https://www.sprite-ai.art/docs/api-reference
      parameters:
      - name: apiid
        in: path
        required: true
        schema:
          type: string
      - 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/GetApiApiidResponse'
      x-evidence:
        kind: code-example
        language: python
        snippet: "requests.get( \n \"https://www.sprite-ai.art/api/animations/\" + job_id, headers = headers, \n )"
        collapsed_from: 9 example path(s) differing only at apiId
    post:
      operationId: post_api_apiid
      tags:
      - Sprite AI API
      summary: POST /api/animations
      x-source: https://www.sprite-ai.art/docs/api-reference
      parameters:
      - name: apiid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiApiidRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiApiidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl JavaScript Python curl https://www.sprite-ai.art/api/animations  -H \"Authorization: Bearer sai_sk_your_key_here\"  -H \"Content-Type: application/json\"  -d '{ \"source_generation_id\": \"a1b2c3d4-...\", \"preset\": \"Walk\", \"frame_count\": 8 }' const res = await fetch ( \"https://www.sprite-ai.art/api/animations\" , { \n method: \"POST\" , \n headers: { \n Authorization: \"Bearer sai_sk_your_key_here\" , \n \"Con"
        collapsed_from: 9 example path(s) differing only at apiId
  /api/{apiid}/{id}:
    get:
      operationId: get_api_apiid_id
      tags:
      - Sprite AI API
      summary: Poll an animation job
      description: Returns the current status and result when completed.
      x-source: https://www.sprite-ai.art/docs/api-reference
      parameters:
      - name: apiid
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiApiidIdResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 5 example path(s) differing only at apiId
components:
  schemas:
    PostApiApiidRequest:
      type: object
      properties:
        source_generation_id:
          type: string
        preset:
          type: string
        frame_count:
          type: integer
    PostApiApiidResponse:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
        frameWidth:
          type: integer
        frameHeight:
          type: integer
        frameCount:
          type: integer
        fps:
          type: integer
        image:
          type: object
          properties:
            format:
              type: string
            spritesheetBase64:
              type: string
    GetApiApiidResponse:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
        frameWidth:
          type: integer
        frameHeight:
          type: integer
        frameCount:
          type: integer
        fps:
          type: integer
        image:
          type: object
          properties:
            format:
              type: string
            spritesheetBase64:
              type: string
    GetApiApiidIdResponse:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
        frameWidth:
          type: integer
        frameHeight:
          type: integer
        frameCount:
          type: integer
        fps:
          type: integer
        image:
          type: object
          description: Contains format and spritesheetBase64.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer