spritecook-ai

spritecook-ai Jobs API

Poll and cancel asynchronous jobs.

GitHub OpenAPI

Operations 2

GET /v1/api/jobs/{job_id} Check the status of a generation or animation job #
POST /v1/api/jobs/{job_id}/cancel Cancel a queued or running job through the public API #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/spritecook-ai/openapi/spritecook-ai-jobs-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/spritecook-ai/json-schema/spritecook-ai-api-asset-metadata-schema.json
📊
JSONSchema
https://artifacts.apis.io/spritecook-ai/json-schema/spritecook-ai-api-generate-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/spritecook-ai/json-schema/spritecook-ai-api-animate-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/spritecook-ai/json-schema/spritecook-ai-api-tileset-generate-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/spritecook-ai/json-schema/spritecook-ai-api-asset-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/spritecook-ai/json-schema/spritecook-ai-api-job-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/spritecook-ai:spritecook-ai-jobs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

spritecook-ai-jobs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SpriteCook Jobs API
  description: 'Generate and animate 2D game art (pixel art and detailed/HD) from code.


    Authenticate with an API key in the `Authorization: Bearer sc_live_...` header.

    Create keys on the API Keys page (https://app.spritecook.ai/api-keys); each key

    carries a set of scopes (see the `apiKey` security scheme). New accounts get

    free credits, no card needed.


    Long-running work is asynchronous: submit a job, then poll

    `GET /v1/api/jobs/{job_id}` with the returned `poll_url`. The `*-sync`

    variants wait up to 90 seconds and return the finished job.


    Errors use one envelope: `{"detail": {"error": {"code": "...", "message": "..."}}}`.


    Prefer the MCP server (https://api.spritecook.ai/mcp) when you are an agent

    that speaks MCP; it exposes the same capabilities as tools.'
  version: 1.0.0
  summary: AI pixel art and 2D game asset generation API.
  termsOfService: https://www.spritecook.ai/terms
  contact:
    name: SpriteCook support
    email: support@spritecook.ai
    url: https://www.spritecook.ai/contact
servers:
- url: https://api.spritecook.ai
  description: Production
security:
- apiKey: []
tags:
- name: Jobs
  description: Poll and cancel asynchronous jobs.
paths:
  /v1/api/jobs/{job_id}:
    get:
      summary: Check the status of a generation or animation job
      description: Check the status of a generation or animation job.
      operationId: getJob
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiJobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '400':
          description: The request is invalid. `detail.error.code` says why (for example `invalid_request`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '402':
          description: Not enough credits (`insufficient_credits`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: The API key lacks the required scope (`scope_denied`) or the account cannot use this feature.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The asset, job or run was not found or does not belong to you.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: Rate limit or queue limit reached. Retry later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
      - Jobs
      security:
      - apiKey:
        - read_assets
      x-required-scope: read_assets
  /v1/api/jobs/{job_id}/cancel:
    post:
      summary: Cancel a queued or running job through the public API
      description: Cancel a queued or running job through the public API.
      operationId: cancelJob
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: ApiCancelJobResponse
                type: object
                required:
                - ok
                properties:
                  ok:
                    type: boolean
                    description: True when the cancel request was accepted.
                  cancelled:
                    type: boolean
                    description: True when the job stopped immediately.
                  cancellation_pending:
                    type: boolean
                    description: True when a running job will stop shortly.
                additionalProperties: true
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '400':
          description: The request is invalid. `detail.error.code` says why (for example `invalid_request`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '402':
          description: Not enough credits (`insufficient_credits`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: The API key lacks the required scope (`scope_denied`) or the account cannot use this feature.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The asset, job or run was not found or does not belong to you.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: Rate limit or queue limit reached. Retry later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
      - Jobs
      security:
      - apiKey:
        - generate
      x-required-scope: generate
components:
  schemas:
    ApiAnimationOutputMetadata:
      properties:
        frame_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Frame Count
        fps:
          anyOf:
          - type: integer
          - type: 'null'
          title: Fps
        frame_width:
          anyOf:
          - type: integer
          - type: 'null'
          title: Frame Width
        frame_height:
          anyOf:
          - type: integer
          - type: 'null'
          title: Frame Height
        animation_mode:
          anyOf:
          - type: string
          - type: 'null'
          title: Animation Mode
      type: object
      title: ApiAnimationOutputMetadata
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ApiJobResponse:
      properties:
        job_id:
          type: string
          title: Job Id
        status:
          type: string
          title: Status
        progress:
          anyOf:
          - type: integer
          - type: 'null'
          title: Progress
        character_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Character Id
        assets:
          anyOf:
          - items:
              $ref: '#/components/schemas/ApiAssetInfo'
            type: array
          - type: 'null'
          title: Assets
        output:
          anyOf:
          - $ref: '#/components/schemas/ApiAnimationOutput'
          - type: 'null'
        file:
          anyOf:
          - $ref: '#/components/schemas/ApiBackgroundRemovalFile'
          - type: 'null'
        error:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Error
        credits_used:
          anyOf:
          - type: integer
          - type: 'null'
          title: Credits Used
        credits_remaining:
          anyOf:
          - type: integer
          - type: 'null'
          title: Credits Remaining
        poll_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Poll Url
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
        finished_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Finished At
        service_notice:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Service Notice
      type: object
      required:
      - job_id
      - status
      title: ApiJobResponse
    ApiError:
      title: ApiError
      type: object
      required:
      - detail
      properties:
        detail:
          type: object
          required:
          - error
          properties:
            error:
              type: object
              required:
              - code
              - message
              properties:
                code:
                  type: string
                  description: Stable machine-readable error code, for example `insufficient_credits`.
                message:
                  type: string
                  description: Human-readable explanation.
                details:
                  type: object
                  additionalProperties: true
    ApiBackgroundRemovalFile:
      properties:
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
        content_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Type
        media_kind:
          type: string
          enum:
          - image
          - animation
          title: Media Kind
        width:
          anyOf:
          - type: integer
          - type: 'null'
          title: Width
        height:
          anyOf:
          - type: integer
          - type: 'null'
          title: Height
        frame_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Frame Count
        fps:
          anyOf:
          - type: integer
          - type: 'null'
          title: Fps
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
          description: When this temporary file stops being available (ISO 8601). Download it before then.
        expired:
          type: boolean
          title: Expired
          description: True once the file is no longer available; url is then null.
          default: false
      type: object
      required:
      - media_kind
      title: ApiBackgroundRemovalFile
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ApiAnimationOutput:
      properties:
        asset_id:
          type: string
          title: Asset Id
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
        spritesheet_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Spritesheet Url
        content_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Type
        metadata:
          $ref: '#/components/schemas/ApiAnimationOutputMetadata'
      type: object
      required:
      - asset_id
      - metadata
      title: ApiAnimationOutput
    ApiAssetInfo:
      properties:
        id:
          type: string
          title: Id
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
        sprite_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Sprite Url
        spritesheet_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Spritesheet Url
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        file_name:
          anyOf:
          - type: string
          - type: 'null'
          title: File Name
        width:
          anyOf:
          - type: integer
          - type: 'null'
          title: Width
        height:
          anyOf:
          - type: integer
          - type: 'null'
          title: Height
        prompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
        asset_kind:
          anyOf:
          - type: string
          - type: 'null'
          title: Asset Kind
        tilesetKind:
          anyOf:
          - type: string
          - type: 'null'
          title: Tilesetkind
        tilesetPieceSet:
          anyOf:
          - type: string
          - type: 'null'
          title: Tilesetpieceset
        tilesetPerspective:
          anyOf:
          - type: string
          - type: 'null'
          title: Tilesetperspective
        tilesetElevation:
          anyOf:
          - type: string
          - type: 'null'
          title: Tilesetelevation
        tilesetTileSize:
          anyOf:
          - type: integer
          - type: 'null'
          title: Tilesettilesize
        tilesetStyleMode:
          anyOf:
          - type: string
          - type: 'null'
          title: Tilesetstylemode
        tilesetGridSize:
          anyOf:
          - type: integer
          - type: 'null'
          title: Tilesetgridsize
        tilesetGridWidth:
          anyOf:
          - type: integer
          - type: 'null'
          title: Tilesetgridwidth
        tilesetGridHeight:
          anyOf:
          - type: integer
          - type: 'null'
          title: Tilesetgridheight
        tilesetOutputSize:
          anyOf:
          - type: integer
          - type: 'null'
          title: Tilesetoutputsize
        tilesetOutputWidth:
          anyOf:
          - type: integer
          - type: 'null'
          title: Tilesetoutputwidth
        tilesetOutputHeight:
          anyOf:
          - type: integer
          - type: 'null'
          title: Tilesetoutputheight
        tilesetAtlasColumns:
          anyOf:
          - type: integer
          - type: 'null'
          title: Tilesetatlascolumns
        tilesetAtlasRows:
          anyOf:
          - type: integer
          - type: 'null'
          title: Tilesetatlasrows
        tilesetEdges:
          anyOf:
          - type: string
          - type: 'null'
          title: Tilesetedges
      type: object
      required:
      - id
      title: ApiAssetInfo
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: sc_live_ API key
      description: 'SpriteCook API key sent as `Authorization: Bearer sc_live_...`. Create one at https://app.spritecook.ai/api-keys and grant only the scopes you need. Each operation lists its required scope in `security`.


        - `generate`: Create, animate, import, slice and clean up assets, and manage the jobs they start. Spends credits.

        - `read_assets`: Read metadata and download URLs for assets you own.

        - `read_credits`: Read your credit balance.

        - `report_errors`: Send integration error reports to SpriteCook (used by the MCP server).'
externalDocs:
  description: API guide with examples
  url: https://www.spritecook.ai/api-docs
x-spritecook-scopes:
  generate: Create, animate, import, slice and clean up assets, and manage the jobs they start. Spends credits.
  read_assets: Read metadata and download URLs for assets you own.
  read_credits: Read your credit balance.
  report_errors: Send integration error reports to SpriteCook (used by the MCP server).