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

# Get a model

> Retrieve a single model with its supported parameters and pricing.



## OpenAPI

````yaml /openapi.yaml get /v2/models/{model}
openapi: 3.1.0
info:
  title: getimg.ai API
  version: 2.0.0
  description: |
    The getimg.ai API for image and video generation.

    Authenticate with a bearer token in the format `sk_<secret>`.
servers:
  - url: https://api.getimg.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Images
    description: Endpoints for image generation.
  - name: Models
    description: Endpoints for listing available developer models.
  - name: Videos
    description: Endpoints for video generation.
  - name: Billing
    description: Developer API balance and usage costs.
paths:
  /v2/models/{model}:
    get:
      tags:
        - Models
      summary: Get a model
      description: Retrieve a single model with its supported parameters and pricing.
      operationId: getModel
      parameters:
        - name: model
          in: path
          required: true
          description: The model identifier returned by the models list.
          schema:
            type: string
            minLength: 1
          example: seedream-5-lite
      responses:
        '200':
          description: Developer model details.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperModelListItem'
              examples:
                image_model:
                  summary: Image model
                  value:
                    id: seedream-5-lite
                    name: Seedream 5 Lite
                    type: image
                    supported_aspect_ratios:
                      - '1:1'
                      - '16:9'
                    supported_durations: []
                    supported_resolutions:
                      - 2K
                      - 4K
                    supports_sound: false
                    supported_references:
                      reference_image: 14
                    pricing:
                      currency: USD
                      rates:
                        - resolution: 2K
                          sound: not_applicable
                          billable_unit: image
                          unit_price: '0.1400'
                    created_at: '2026-04-17T10:20:30.000Z'
                video_model:
                  summary: Video model
                  value:
                    id: seedance-v1-pro
                    name: Seedance v1 Pro
                    type: video
                    supported_aspect_ratios:
                      - '16:9'
                      - '9:16'
                    supported_durations:
                      - 5
                      - 10
                    supported_resolutions:
                      - 1080p
                    supports_sound: false
                    supported_references:
                      first_frame: 1
                    pricing:
                      currency: USD
                      rates:
                        - resolution: 1080p
                          sound: sound_off
                          billable_unit: video_second
                          unit_price: '0.1400'
                    created_at: '2026-04-16T09:10:00.000Z'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import GetimgAI from "getimg-ai";

            const client = new GetimgAI();

            const model = await client.models.retrieve("seedream-5-lite");
        - lang: python
          label: Python
          source: |
            from getimg import GetimgAI

            client = GetimgAI()

            model = client.models.retrieve("seedream-5-lite")
components:
  headers:
    X-RateLimit-Limit:
      description: Maximum requests allowed in the current rate-limit window.
      schema:
        type: string
        pattern: ^[0-9]+$
      example: '60'
    X-RateLimit-Remaining:
      description: Remaining requests in the current rate-limit window.
      schema:
        type: string
        pattern: ^[0-9]+$
      example: '59'
    X-RateLimit-Reset:
      description: Unix timestamp (seconds) when the current rate-limit window resets.
      schema:
        type: string
        pattern: ^[0-9]+$
      example: '1760000042'
  schemas:
    DeveloperModelListItem:
      type: object
      required:
        - id
        - name
        - type
        - created_at
        - supported_aspect_ratios
        - supported_durations
        - supported_resolutions
        - supports_sound
        - supported_references
        - pricing
      properties:
        id:
          type: string
          description: The model identifier.
        name:
          type: string
          description: The model display name.
        type:
          type: string
          enum:
            - image
            - video
          description: The generation type supported by the model.
        supported_aspect_ratios:
          type: array
          items:
            type: string
          description: >-
            Supported aspect ratios in default order; the first is used when
            omitted.
        supported_durations:
          type: array
          items:
            type: number
          description: >-
            Supported durations in seconds; empty for image models. The first is
            the default.
        supported_resolutions:
          type: array
          items:
            type: string
          description: >-
            Supported resolutions in default order; the first is used when
            omitted.
        supports_sound:
          type: boolean
          description: Whether sound generation is supported.
        supported_references:
          type: object
          additionalProperties:
            type: integer
          description: >-
            Maximum reference count per supported role (reference_image,
            first_frame, last_frame).
        pricing:
          type: object
          required:
            - currency
            - rates
          properties:
            currency:
              type: string
              enum:
                - USD
            rates:
              type: array
              description: >-
                Currently effective catalog rates, ordered by unit price. Empty
                when no active rates are configured; this does not mean
                generation is free.
              items:
                $ref: '#/components/schemas/DeveloperModelRate'
        created_at:
          type: string
          format: date-time
          description: Timestamp when the model was created.
    DeveloperModelRate:
      type: object
      required:
        - resolution
        - sound
        - billable_unit
        - unit_price
      properties:
        resolution:
          type:
            - string
            - 'null'
          description: >-
            Resolution this rate applies to, or null for a
            resolution-independent rate.
        sound:
          type: string
          enum:
            - sound_on
            - sound_off
            - not_applicable
          description: >-
            Sound setting this rate applies to; not_applicable also serves as a
            video fallback.
        billable_unit:
          type: string
          description: Unit billed, such as image or video_second.
        unit_price:
          type: string
          description: USD price per billable unit, represented as a decimal string.
          example: '0.1400'
    PublicApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
            - param
            - code
          properties:
            message:
              type: string
            type:
              type: string
              const: invalid_request_error
            param:
              anyOf:
                - type: string
                - type: 'null'
            code:
              type: string
              enum:
                - invalid_api_key
                - parameter_missing
                - invalid_parameter
                - quota_exceeded
                - rate_limit
                - content_policy_violation
                - not_found
                - server_error
            doc_url:
              type: string
              format: uri
  responses:
    BadRequestError:
      description: The request payload or parameters are invalid.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
          examples:
            invalid_parameter:
              value:
                error:
                  message: Unsupported resolution '8K' for model 'seedream-5-lite'.
                  type: invalid_request_error
                  param: resolution
                  code: invalid_parameter
            parameter_missing:
              value:
                error:
                  message: Required parameter 'prompt' is missing.
                  type: invalid_request_error
                  param: prompt
                  code: parameter_missing
    UnauthorizedError:
      description: Authentication failed due to a missing or invalid API key.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
          examples:
            invalid_api_key:
              value:
                error:
                  message: >-
                    Incorrect API key provided. You can manage your API keys at
                    https://getimg.ai/app/developer/api-keys
                  type: invalid_request_error
                  param: null
                  code: invalid_api_key
                  doc_url: https://docs.getimg.ai/guides/authentication
    NotFoundError:
      description: The requested resource was not found.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
          examples:
            not_found:
              value:
                error:
                  message: The resource doesn't exist.
                  type: invalid_request_error
                  param: null
                  code: not_found
    ServerError:
      description: An unexpected server error occurred.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
          examples:
            server_error:
              value:
                error:
                  message: Something went wrong on our end.
                  type: invalid_request_error
                  param: null
                  code: server_error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: |
        Send your API key as a bearer token:
        `Authorization: Bearer sk_<secret>`.

````