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

# List Models



## OpenAPI

````yaml https://api.aiql.io/openapi.json get /v1/models
openapi: 3.1.0
info:
  title: aiql-api
  version: 0.1.0
servers:
  - url: https://api.aiql.io
security: []
tags:
  - name: Health
    description: Service health checks.
  - name: Workspaces
    description: Workspace management.
  - name: Ingestions
    description: Document ingestion pipeline.
  - name: Queries
    description: Natural-language queries.
  - name: Sources
    description: Ingested sources and their contents.
  - name: Requests
    description: Source addition/removal requests awaiting review.
  - name: Request Changes
    description: Individual source add/remove changes on a request.
  - name: Request Reviews
    description: Reviews of a request, including draft and submit.
  - name: Request Comments
    description: Comments on a request review.
  - name: Canvases
    description: Brainstorm canvases.
  - name: Dashboards
    description: Dashboards.
  - name: Presentations
    description: Slide presentations.
  - name: Patterns
    description: User-defined ontology patterns and matched instances.
  - name: Written Documents
    description: Authored documents.
  - name: Prompts
    description: Reusable prompt templates.
  - name: Apps
    description: Workspace automations.
  - name: Tools
    description: Standalone convert/split/shape/extract tools.
  - name: Realtime
    description: Voice session mint and tool execution.
  - name: Connectors
    description: Connector catalog and connect flows.
  - name: Connections
    description: Workspace connector connections.
  - name: Chat Completions
    description: OpenAI-compatible chat completions over workspace queries.
paths:
  /v1/models:
    get:
      tags:
        - Chat Completions
      summary: List Models
      operationId: list_models_v1_models_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelList'
        '401':
          description: 'Authentication failed: missing or invalid API key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - HTTPBearer: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl https://api.aiql.io/v1/models \
              -H "Authorization: Bearer $AIQL_API_KEY"
        - lang: python
          label: Python
          source: |
            import os
            from openai import OpenAI

            client = OpenAI(
                base_url="https://api.aiql.io/v1",
                api_key=os.environ["AIQL_API_KEY"],
            )

            models = client.models.list()
            print([model.id for model in models.data])
        - lang: typescript
          label: TypeScript
          source: |
            import OpenAI from "openai";

            const client = new OpenAI({
              baseURL: "https://api.aiql.io/v1",
              apiKey: process.env.AIQL_API_KEY,
            });

            const models = await client.models.list();
            console.log(models.data.map((model) => model.id));
components:
  schemas:
    ModelList:
      properties:
        object:
          type: string
          const: list
          title: Object
          default: list
        data:
          items:
            $ref: '#/components/schemas/Model'
          type: array
          title: Data
      type: object
      required:
        - data
      title: ModelList
    ErrorResponse:
      type: object
      title: ErrorResponse
      properties:
        detail:
          type: string
          title: Detail
      required:
        - detail
    Model:
      properties:
        id:
          type: string
          title: Id
        object:
          type: string
          const: model
          title: Object
          default: model
        created:
          type: integer
          title: Created
        owned_by:
          type: string
          title: Owned By
      type: object
      required:
        - id
        - created
        - owned_by
      title: Model
  securitySchemes:
    HTTPBearer:
      type: http
      description: API key or UI session JWT passed as a Bearer token.
      scheme: bearer

````

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