> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wondercraft.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List image models

> Lists the image models available through the API, with the resolutions, aspect ratios and
credits per image each one supports. Requires a valid `X-API-KEY` header.



## OpenAPI

````yaml GET /image/models
openapi: 3.1.0
info:
  title: Wondercraft Public API
  version: 0.0.1
servers:
  - url: https://api.wondercraft.ai/v1
    description: Base Wondercraft API
security: []
paths:
  /image/models:
    get:
      tags:
        - Images
      summary: List image models
      description: >-
        Lists the image models available through the API, with the resolutions,
        aspect ratios and

        credits per image each one supports. Requires a valid `X-API-KEY`
        header.
      operationId: list_image_models_image_models_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListImageModelsResponse'
      security:
        - APIKeyHeader: []
components:
  schemas:
    ListImageModelsResponse:
      properties:
        models:
          items:
            $ref: '#/components/schemas/ApiImageModel'
          type: array
          title: Models
          description: Image models available through the API
      type: object
      required:
        - models
      title: ListImageModelsResponse
    ApiImageModel:
      properties:
        id:
          type: string
          title: Id
          description: Model ID to pass as `model_id` when generating
        title:
          type: string
          title: Title
          description: Display name of the model
        description:
          type: string
          title: Description
          description: What the model is good at
        resolutions:
          items:
            $ref: '#/components/schemas/ApiResolution'
          type: array
          title: Resolutions
          description: Output resolutions this model supports
        default_resolution:
          $ref: '#/components/schemas/ApiResolution'
          description: Resolution used when the request sends none
        aspect_ratios:
          items:
            $ref: '#/components/schemas/ApiAspectRatio'
          type: array
          title: Aspect Ratios
          description: Aspect ratios this model supports
        supports_reference_images:
          type: boolean
          title: Supports Reference Images
          description: Whether `reference_image_ids` can be sent
        max_reference_images:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Reference Images
          description: >-
            Maximum number of reference images, or null when the model sets no
            limit
        credits_by_resolution:
          additionalProperties:
            type: number
          propertyNames:
            $ref: '#/components/schemas/ApiResolution'
          type: object
          title: Credits By Resolution
          description: Credits charged per generated image at each supported resolution
      type: object
      required:
        - id
        - title
        - description
        - resolutions
        - default_resolution
        - aspect_ratios
        - supports_reference_images
        - credits_by_resolution
      title: ApiImageModel
    ApiResolution:
      type: string
      enum:
        - 480p
        - 720p
        - 1080p
        - 2k
        - 4k
      title: ApiResolution
      description: >-
        Output resolution shared by the image and video APIs; each model lists
        the values it supports.
    ApiAspectRatio:
      type: string
      enum:
        - '16:9'
        - '9:16'
        - '1:1'
      title: ApiAspectRatio
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-KEY

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.