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

# Get Models

> Retorna a lista de modelos de IA disponíveis na Muffins AI.



## OpenAPI

````yaml GET /ai-model
openapi: 3.1.0
info:
  title: Muffins AI API
  description: >-
    API oficial da Muffins AI, oferecendo ferramentas avançadas de inteligência
    artificial para integração com seus sistemas.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://chat.muffinscorp.com/api/public
security:
  - apiKeyAuth: []
paths:
  /ai-model:
    get:
      description: Retorna a lista de modelos de IA disponíveis na Muffins AI.
      responses:
        '200':
          description: Lista de modelos retornada com sucesso.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Model'
        '400':
          description: Erro na solicitação.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Não autorizado - API key inválida ou faltando.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Model:
      type: object
      properties:
        id:
          description: Identificador único do modelo.
          type: string
          format: uuid
        valueId:
          description: Identificador técnico do modelo para uso na API.
          type: string
        name:
          description: Nome amigável do modelo exibido aos usuários.
          type: string
        type:
          description: 'Tipo do modelo (ex: ''text'', ''image'', etc.).'
          type: string
        costInCreditPerUse:
          description: Custo em créditos por uso do modelo.
          type: number
        isActive:
          description: Indica se o modelo está ativo e disponível para uso.
          type: boolean
        createdAt:
          description: Data de criação do modelo no sistema.
          type: string
          format: date-time
        totalUses:
          description: Quantidade total de vezes que o modelo foi utilizado.
          type: string
        totalCreditsSpent:
          description: Total de créditos gastos com este modelo.
          type: string
        max_tokens:
          description: Número máximo de tokens suportado pelo modelo (opcional).
          type: integer
      required:
        - id
        - valueId
        - name
        - type
        - costInCreditPerUse
        - isActive
        - createdAt
    Error:
      type: object
      required:
        - error
        - code
        - success
      properties:
        error:
          description: Descrição legível do erro.
          type: string
          example: Invalid API Key
        code:
          description: Código de erro padrão para tratamento programático.
          type: string
          enum:
            - AUTH_FAILED
            - INVALID_INPUT
            - RATE_LIMITED
            - SERVER_ERROR
          example: AUTH_FAILED
        message:
          description: Mensagem detalhada do erro (opcional).
          type: string
        traceId:
          description: ID único para rastreamento do erro no servidor.
          type: string
          format: uuid
        success:
          description: Indica se a requisição foi bem sucedida (sempre false para erros).
          type: boolean
          enum:
            - false
        details:
          description: Informações técnicas adicionais para depuração.
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: x-api-key
      in: header
      description: API key for authentication

````