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

# List available LLMs

> List the LLMs the caller may pass as `requestedLlm` on the [Create AI job](/api/ai/create-ai-job) and [Generate a query](/api/ai/generate-a-query) endpoints.

The response includes the organization's [approved LLMs](/ai/settings/llm-settings), [test-only](/ai/settings/llm-settings#test-only) LLMs only for organization admins, only the default for an embedded user, and only the [downgrade LLM](/ai/settings/usage#downgrade) while the organization is over its AI credit downgrade threshold.




## OpenAPI

````yaml /api/openapi.yaml get /v1/ai/llms
openapi: 3.1.0
info:
  title: Omni API
  description: >
    The Omni REST API provides programmatic access to your Omni instance for
    managing users, documents, queries, schedules, and more.  
  version: 1.0.0
  contact:
    name: Omni Support
    url: https://docs.omni.co
servers:
  - url: https://{instance}.omniapp.co/api
    description: Production
    variables:
      instance:
        default: blobsrus
        description: Your production Omni instance subdomain
  - url: https://{instance}.playground.exploreomni.dev/api
    description: Playground
    variables:
      instance:
        default: blobsrus
        description: Your playground Omni instance subdomain
security:
  - bearerAuth: []
  - orgApiKey: []
tags:
  - name: Who Am I
    description: Inspect your own user permissions
  - name: AI
    description: AI-powered query generation
  - name: AI Credit Controls
    description: Manage organization-level AI credit usage
  - name: AI Credit Usage
    description: Monitor AI credit usage
  - name: AI Evals
    description: >-
      Manage prompt sets and runs used to score AI quality against curated
      prompt suites.
  - name: AI Model Suggestions
    description: Manage AI-generated suggestions for shared models
  - name: AI Routines
    description: >-
      Manage Routines, which are scheduled, recurring AI-powered tasks that run
      automatically on your data
  - name: Apps
    description: Draft and publish app documents.
  - name: App downloads
    description: Download apps as PNG, PDF, XLSX, or CSV files
  - name: Documents v2
    description: >
      A draft-based workflow for creating and editing documents: create a
      document, patch a draft, then publish.
  - name: Documents
    description: Create, retrieve, and manage documents
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: IP Allowlist
    description: Manage the organization's IP allowlist
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - name: Color Palettes
    description: Manage custom chart color palettes
  - name: Content
    description: Unified content retrieval (documents and folders)
  - name: Content migration
    description: Export and import dashboards
  - name: Content validator
    description: Validate content against models and perform find/replace operations
  - name: Dashboard downloads
    description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
  - name: Dashboard filters and controls
    description: Read and update dashboard filter and control default values
  - name: dbt
    description: Manage dbt configuration for connections
  - name: Document favorites
    description: Favorite and unfavorite documents
  - name: Document labels
    description: Apply and manage labels on documents
  - name: Document permissions
    description: Manage document-level access
  - name: Embed
    description: Manage embed sessions
  - name: Labels
    description: |
      Manage labels in the organization
  - name: Folders
    description: Create and organize content folders
  - name: Folder favorites
    description: Favorite and unfavorite folders
  - name: Folder labels
    description: Apply and manage labels on folders
  - name: Folder permissions
    description: Manage folder-level access
  - name: Jobs
    description: Check status of asynchronous jobs
  - name: Models
    description: Create and manage data models
  - name: Model branches
    description: Manage model branches and merge changes
  - name: Model git configuration
    description: Manage git configuration for shared models
  - name: Queries
    description: Execute workbook queries
  - name: Schedules
    description: Create and manage scheduled tasks
  - name: Schedule recipients
    description: Manage schedule recipients
  - name: Schema refresh schedules
    description: Manage automated schema refresh schedules for connections
  - name: Skills
    description: >-
      Manage skills, the saved slash-command instructions the Omni AI assistant
      runs
  - name: Topics
    description: Retrieve topic information from models
  - name: Uploads
    description: Manage file uploads
  - name: Users
    description: Manage users
  - name: User attributes
    description: Manage user attribute definitions
  - name: User groups
    description: Manage user groups
  - name: User model roles
    description: Manage model and connection role assignments for users
  - name: User group model roles
    description: Manage model and connection role assignments for user groups
  - name: Uploads
    description: Manage CSV and spreadsheet uploads
paths:
  /v1/ai/llms:
    get:
      tags:
        - AI
      summary: List available LLMs
      description: >
        List the LLMs the caller may pass as `requestedLlm` on the [Create AI
        job](/api/ai/create-ai-job) and [Generate a
        query](/api/ai/generate-a-query) endpoints.


        The response includes the organization's [approved
        LLMs](/ai/settings/llm-settings),
        [test-only](/ai/settings/llm-settings#test-only) LLMs only for
        organization admins, only the default for an embedded user, and only the
        [downgrade LLM](/ai/settings/usage#downgrade) while the organization is
        over its AI credit downgrade threshold.
      operationId: aiLlmsList
      parameters:
        - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: Available LLMs retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                required:
                  - llms
                properties:
                  llms:
                    type: array
                    description: |
                      The LLMs the caller may pass.
                    items:
                      type: object
                      required:
                        - description
                        - isDefault
                        - label
                        - model
                        - provider
                        - thinkingLevels
                      properties:
                        label:
                          type: string
                          description: Display name, as it displays in the chat picker
                          example: Claude Sonnet 5.5
                        description:
                          $ref: '#/components/schemas/AiLlmDescription'
                          description: |
                            The LLM's description.
                        model:
                          $ref: '#/components/schemas/AiLlmModel'
                          description: >
                            The LLM. Use this value when passing
                            `requestedLlm.model`.
                        provider:
                          $ref: '#/components/schemas/AiLlmProvider'
                          description: >
                            The LLM provider. Use this value when passing
                            `requestedLlm.provider`.
                        thinkingLevels:
                          $ref: '#/components/schemas/AiLlmThinkingLevels'
                          description: >
                            The thinking levels this LLM supports, any of which
                            may be passed as `requestedLlm.thinking`.
                        isDefault:
                          $ref: '#/components/schemas/AiLlmIsDefault'
                          description: >
                            Whether this is the LLM a job or query runs on when
                            it doesn't name a `requestedLlm`.
              example:
                llms:
                  - label: Claude Sonnet 5.5
                    description: Fast answers for quick lookups
                    model: claude-sonnet-5-5
                    provider: bedrock
                    thinkingLevels:
                      - default
                      - low
                      - medium
                      - high
                    isDefault: true
                  - label: Claude Opus 5.5
                    description: Deeper analysis for complex questions
                    model: claude-opus-5-5
                    provider: bedrock
                    thinkingLevels:
                      - default
                      - medium
                      - high
                    isDefault: false
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError401'
        '403':
          description: >-
            AI query generation is not enabled for the organization, the user
            cannot use AI, or a Personal Access Token passed another user's
            `userId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError403'
        '404':
          description: The `userId` does not name a user in this organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError404'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    userId:
      name: userId
      schema:
        type: string
        format: uuid
      required: false
      description: >
        **Organization API key required.** The membership ID of the user to act
        as.
      in: query
  schemas:
    AiLlmDescription:
      type: string
      description: |
        The LLM's description.
      example: Fast answers for quick lookups
    AiLlmModel:
      type: string
      minLength: 1
      maxLength: 512
      description: >
        The LLM's catalog name on an Omni-managed provider (e.g.
        `claude-sonnet-5`) or the LLM's ID if using [Bring your own
        key](/ai/settings/model-providers/index).
      example: claude-sonnet-5-5
    AiLlmProvider:
      type: string
      enum:
        - bedrock
        - anthropic
        - openai
        - grok
        - snowflake_cortex
        - openai_compatible
        - fireworks
        - fireworks_managed
        - databricks_genie
        - vertex_ai
      description: |
        The LLM provider. Use this value when passing `requestedLlm.provider`.
      example: bedrock
    AiLlmThinkingLevels:
      type: array
      items:
        type: string
        enum:
          - default
          - none
          - low
          - medium
          - high
      description: >
        The thinking levels this LLM supports, any of which may be passed as
        `requestedLlm.thinking`.
      example:
        - default
        - low
        - medium
        - high
    AiLlmIsDefault:
      type: boolean
      description: >
        Whether this is the LLM a job or query runs on when it doesn't name a
        `requestedLlm`.
      example: false
    ApiError401:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
          example: 'Unauthorized: Missing or invalid API key'
        status:
          type: integer
          description: HTTP status code of the error.
          example: 401
      required:
        - detail
        - status
    ApiError403:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 403
      required:
        - detail
        - status
    ApiError404:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 404
      required:
        - detail
        - status
    Error:
      type: object
      properties:
        error:
          type: string
          description: HTTP response code for the error
          example: <response_code>
        message:
          type: string
          description: Detailed error description
          example: <error_reason>
  responses:
    TooManyRequests:
      description: Too Many Requests - Rate limit exceeded (60 requests/minute)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Can be either an [Organization API
        Key](/api/authentication#organization-api-keys) or [Personal Access
        Token (PAT)](/api/authentication#token-types).


        Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
    orgApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Requires an [Organization API
        Key](/api/authentication#organization-api-keys). Personal Access Tokens
        (PATs) are not supported for this endpoint.


        Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`

````

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