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

# Get apiv1aimodels

> Get models - returns all for admin, active only for others



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/ai/models
openapi: 3.0.0
info:
  title: Flowra API (API Key Endpoints)
  description: >-
    **Flowra** is an AI-powered platform for building agents, workflows, and
    integrations.


    ### Capabilities

    - **Tools & Toolkits** – Define and group tools for agents and workflows.

    - **Workflows** – Orchestrate steps and automate processes.

    - **Triggers** – Schedule or event-based execution.

    - **Auth & Connections** – OAuth, API keys, and connected accounts.

    - **MCP** – Model Context Protocol server integration.

    - **Knowledge / RAG** – Add files and URLs for retrieval-augmented
    generation.


    ### Authentication

    Use the **x-api-key** header with a project API key to access endpoints that
    support API Key auth. Create and manage API keys in the dashboard under your
    project settings.


    Only endpoints that support API Key authentication via the @ApiKeyEnabled()
    decorator.


    Send x-api-key (required). On multi-tenant endpoints, optionally send
    x-username to act as an external user.
  version: '1.0'
  contact:
    name: Flowra
    url: https://flowra.dev
servers:
  - url: https://flowra.dev
    description: Flowra API
security: []
tags:
  - name: Users
    description: User profile
  - name: External Users
    description: End-user identities inside a project (x-username)
  - name: Auth Configs
    description: OAuth and API key configs for toolkits
  - name: Connected Accounts
    description: OAuth connected accounts and link creation
  - name: Toolkits
    description: List and search toolkits
  - name: Tools
    description: List, execute, and manage tools
  - name: Skills
    description: Browse, create, import, and install skills
  - name: Workflow & Agent
    description: Create, run, and inspect workflows and agents
  - name: Triggers
    description: Schedule and event-based trigger instances
  - name: Chat
    description: Threads and streaming agent runs
  - name: File
    description: Upload, list, and download files
  - name: Knowledge
    description: RAG knowledge collections
  - name: Table
    description: Collections and documents
  - name: Sandbox
    description: Ephemeral and durable code sandboxes
  - name: Browser
    description: Live browser sessions and view
  - name: LLM
    description: List AI models and generate completions
  - name: MCP
    description: MCP server management
  - name: usage
    description: Credit balance and usage ledger for the project API key
paths:
  /api/v1/ai/models:
    get:
      tags:
        - LLM
      description: Get models - returns all for admin, active only for others
      operationId: AIModelController_getModels
      parameters:
        - name: kind
          required: false
          in: query
          description: >-
            Catalog to list. Default chat (LLM brains). Use image, video, tts,
            or stt for media models.
          schema:
            default: chat
            example: chat
            enum:
              - chat
              - image
              - video
              - tts
              - stt
            type: string
      responses:
        '200':
          description: List of AI models retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiModelResponseDtoArraySuccessResponse'
              example:
                success: true
                message: Operation completed successfully
                data:
                  - id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                    modelId: openai/gpt-4o-mini
                    canonicalSlug: openai/gpt-4o-mini
                    name: GPT-4o Mini
                    provider: openai
                    contextLength: 128000
                    knowledgeCutoff: 2024-06
                    architecture:
                      modality: text->text
                      inputModalities:
                        - text
                      outputModalities:
                        - text
                    supportedParameters:
                      - temperature
                      - max_tokens
                    pricing:
                      prompt: '0.000001'
                      completion: '0.000002'
                      input: '0.000001'
                      output: '0.000002'
                      cachedInputTokens: '0.0000005'
                      cacheCreationInputTokens: '0.000001'
                    mediaKind: null
                    reserveUsdPerUnit: 0.06
                    mediaCapabilities:
                      unit: second
                      supportsEdit: true
                      defaultVoice: alloy
                      supportedVoices:
                        - alloy
                        - verse
                      durations:
                        - 4
                        - 8
                      resolutions:
                        - 720p
                        - 1080p
                      aspectRatios:
                        - '16:9'
                        - '9:16'
                      sizes:
                        - 1024x1024
                    isActive: true
                    description: ''
                    supportsReasoning: true
                    supportsEffort: true
      security:
        - x-api-key: []
components:
  schemas:
    AiModelResponseDtoArraySuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Success status
          example: true
        message:
          type: string
          description: Success message
          example: Operation completed successfully
        data:
          description: Response data
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Model row UUID
                example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
              modelId:
                type: string
                description: Model id used in API calls
                example: openai/gpt-4o-mini
              canonicalSlug:
                type: string
                nullable: true
                example: openai/gpt-4o-mini
              name:
                type: string
                example: GPT-4o Mini
              provider:
                type: string
                example: openai
              contextLength:
                type: number
                nullable: true
                example: 128000
              knowledgeCutoff:
                type: string
                nullable: true
                example: 2024-06
              architecture:
                type: object
                properties:
                  modality:
                    type: string
                    nullable: true
                    description: OpenRouter modality string (e.g. text->text)
                    example: text->text
                  inputModalities:
                    description: Accepted input modalities
                    example:
                      - text
                    type: array
                    items:
                      type: string
                  outputModalities:
                    description: Produced output modalities
                    example:
                      - text
                    type: array
                    items:
                      type: string
              supportedParameters:
                nullable: true
                example:
                  - temperature
                  - max_tokens
                type: array
                items:
                  type: string
              pricing:
                type: object
                properties:
                  prompt:
                    type: string
                    description: USD per prompt token
                    example: '0.000001'
                  completion:
                    type: string
                    description: USD per completion token
                    example: '0.000002'
                  input:
                    type: string
                    description: UI alias for prompt
                    example: '0.000001'
                  output:
                    type: string
                    description: UI alias for completion
                    example: '0.000002'
                  cachedInputTokens:
                    type: string
                    description: USD per cached input token
                    example: '0.0000005'
                  cacheCreationInputTokens:
                    type: string
                    description: USD per cache-creation input token
                    example: '0.000001'
              mediaKind:
                type: string
                enum:
                  - image
                  - video
                  - tts
                  - stt
                nullable: true
                description: Dedicated media endpoint kind. Null = chat/LLM.
                example: null
              reserveUsdPerUnit:
                type: number
                nullable: true
                description: Worst-case USD per billing unit for credit reserve
                example: 0.06
              mediaCapabilities:
                type: object
                properties:
                  unit:
                    type: string
                    enum:
                      - image
                      - second
                      - char
                      - minute
                    description: Billing unit for credit reserve
                    example: second
                  supportsEdit:
                    type: boolean
                    description: Supports image-to-image / image-to-video edit
                  defaultVoice:
                    type: string
                    example: alloy
                  supportedVoices:
                    example:
                      - alloy
                      - verse
                    type: array
                    items:
                      type: string
                  durations:
                    example:
                      - 4
                      - 8
                    type: array
                    items:
                      type: number
                  resolutions:
                    example:
                      - 720p
                      - 1080p
                    type: array
                    items:
                      type: string
                  aspectRatios:
                    example:
                      - '16:9'
                      - '9:16'
                    type: array
                    items:
                      type: string
                  sizes:
                    example:
                      - 1024x1024
                    type: array
                    items:
                      type: string
              isActive:
                type: boolean
                example: true
              description:
                type: string
                nullable: true
              supportsReasoning:
                type: boolean
                description: Whether the model supports a reasoning/thinking mode
              supportsEffort:
                type: boolean
                description: Whether reasoning effort can be set for this model
            required:
              - id
              - modelId
              - name
              - provider
              - isActive
              - supportsReasoning
              - supportsEffort
          example:
            - id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
              modelId: openai/gpt-4o-mini
              canonicalSlug: openai/gpt-4o-mini
              name: GPT-4o Mini
              provider: openai
              contextLength: 128000
              knowledgeCutoff: 2024-06
              architecture:
                modality: text->text
                inputModalities:
                  - text
                outputModalities:
                  - text
              supportedParameters:
                - temperature
                - max_tokens
              pricing:
                prompt: '0.000001'
                completion: '0.000002'
                input: '0.000001'
                output: '0.000002'
                cachedInputTokens: '0.0000005'
                cacheCreationInputTokens: '0.000001'
              mediaKind: null
              reserveUsdPerUnit: 0.06
              mediaCapabilities:
                unit: second
                supportsEdit: true
                defaultVoice: alloy
                supportedVoices:
                  - alloy
                  - verse
                durations:
                  - 4
                  - 8
                resolutions:
                  - 720p
                  - 1080p
                aspectRatios:
                  - '16:9'
                  - '9:16'
                sizes:
                  - 1024x1024
              isActive: true
              description: ''
              supportsReasoning: true
              supportsEffort: true
      required:
        - success
        - message
        - data
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Project API key. Create and manage keys in the dashboard under Project →
        API Keys. Send as header: x-api-key: <your-key>

````