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

# List models

> Every Summer API model with its id, input schema, output formats, typical time and price. Public, no sign-in.



## OpenAPI

````yaml scripts/api/sources/openapi.json GET /models
openapi: 3.1.0
info:
  title: Summer API
  version: '1'
  description: >-
    Curated, tested game-dev models: 3D, images, video, voice, sound and music,
    into your Summer assets.
servers:
  - url: https://www.summerengine.com/v1
security:
  - bearer: []
paths:
  /models:
    get:
      summary: List Summer API models
      description: >-
        List the curated models: id, capability, input schema, output formats,
        typical time and price. Public; no sign-in.
      operationId: models_list
      parameters:
        - name: capability
          in: query
          required: false
          schema:
            description: 'Only this kind: image, 3d, video, voice, dialogue, sound or music.'
            type: string
            enum:
              - image
              - 3d
              - video
              - voice
              - dialogue
              - sound
              - music
              - motion
      responses:
        '200':
          description: Done.
          content:
            application/json:
              schema:
                type: object
                properties:
                  currency:
                    type: string
                    const: USD
                  topUpFeePercent:
                    description: >-
                      Added to pay-as-you-go credit purchases; model prices
                      carry no other fee.
                    type: number
                  aliases:
                    description: Each <capability>/default alias and the model id it runs.
                    type: object
                    additionalProperties:
                      type: string
                  models:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        datedId:
                          description: >-
                            The same model, dated: shows which price check it
                            follows.
                          type: string
                        capability:
                          type: string
                          enum:
                            - image
                            - 3d
                            - video
                            - voice
                            - dialogue
                            - sound
                            - music
                            - motion
                        name:
                          type: string
                        vendor:
                          type: string
                        tags:
                          type: array
                          items:
                            type: string
                        aliases:
                          description: >-
                            The <capability>/default aliases that run this
                            model.
                          type: array
                          items:
                            type: string
                        outputFormats:
                          type: array
                          items:
                            type: string
                        latency:
                          description: Typical seconds from start to result.
                          anyOf:
                            - type: object
                              properties:
                                p50Seconds:
                                  type: number
                                p90Seconds:
                                  anyOf:
                                    - type: number
                                    - type: 'null'
                                measured:
                                  type: boolean
                              required:
                                - p50Seconds
                                - p90Seconds
                                - measured
                              additionalProperties: false
                            - type: 'null'
                        tier:
                          description: >-
                            free: in Studio, welcome credits may pay for it. The
                            Summer API always uses paid credits.
                          type: string
                          enum:
                            - free
                            - pro
                        commercialUse:
                          type: boolean
                        wellTested:
                          description: Summer's own surfaces run it by default.
                          type: boolean
                        price:
                          type: object
                          properties:
                            unit:
                              type: string
                              enum:
                                - call
                                - output_second
                                - 1k_characters
                                - megapixel
                            price:
                              description: For one unit, at the defaults.
                              type: string
                              pattern: ^\d+(\.\d+)?$
                            quantityField:
                              description: >-
                                The request field that counts the units
                                (numImages, duration, text). Absent: one unit.
                              type: string
                            minimum:
                              description: US dollars as a decimal string.
                              type: string
                              pattern: ^\d+(\.\d+)?$
                            estimate:
                              description: >-
                                A typical request; models.estimate prices the
                                exact one.
                              type: boolean
                              const: true
                            modifiers:
                              type: array
                              items:
                                type: object
                                properties:
                                  field:
                                    description: The request field in input.
                                    type: string
                                  equals:
                                    anyOf:
                                      - type: string
                                      - type: number
                                      - type: boolean
                                  set:
                                    description: Applies when the field is given at all.
                                    type: boolean
                                    const: true
                                  price:
                                    description: Replaces the unit price.
                                    type: string
                                    pattern: ^\d+(\.\d+)?$
                                  add:
                                    description: Adds to the unit price.
                                    type: string
                                    pattern: ^\d+(\.\d+)?$
                                required:
                                  - field
                                additionalProperties: false
                            priceUpdatedAt:
                              description: When the price was last checked, YYYY-MM-DD.
                              type: string
                          required:
                            - unit
                            - price
                            - modifiers
                            - priceUpdatedAt
                          additionalProperties: false
                        inputSchema:
                          description: >-
                            JSON Schema of input for models.run and
                            models.estimate.
                          type: object
                          additionalProperties: {}
                        voices:
                          description: >-
                            Voice and dialogue models: the curated voiceId
                            values; voices.search finds the rest.
                          type: array
                          items:
                            type: object
                            properties:
                              voiceId:
                                type: string
                              name:
                                type: string
                            required:
                              - voiceId
                              - name
                            additionalProperties: false
                      required:
                        - id
                        - datedId
                        - capability
                        - name
                        - vendor
                        - tags
                        - aliases
                        - outputFormats
                        - latency
                        - tier
                        - commercialUse
                        - wellTested
                        - price
                        - inputSchema
                      additionalProperties: false
                required:
                  - currency
                  - topUpFeePercent
                  - aliases
                  - models
                additionalProperties: false
        default:
          description: An error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
            - request_id
            - doc_url
          properties:
            type:
              type: string
            code:
              type: string
              description: >-
                A stable code: invalid_input, not_signed_in, no_credits (the
                paid balance), over_limit (the app's own spend limit), ...
            message:
              type: string
            param:
              type:
                - string
                - 'null'
              description: The field to fix, such as input.prompt or Idempotency-Key.
            request_id:
              type: string
            doc_url:
              type: string
            fix_url:
              type: string
              description: Where the person fixes it, such as adding credits.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A Summer sign-in: an OAuth 2.1 access token, valid one hour. Sign in
        once with npx -y summer-engine login, then print a token with summer
        token. Each app you sign in spends your paid credits up to the limit you
        set in Connected apps.

````

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