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

# List models

> The public model catalogue: every canonical model with its provider
routes, capability data, pricing rule and operational metadata. Auth is
optional; models of the `pipeline` tool appear only for callers granted
access to them. Pass a canonical name (auto-routing) or a route's
`model_key` (exact route pinning) as `model` when creating jobs. Schemas
are not inlined; follow each route's `schema_url`. Amounts are in cents.




## OpenAPI

````yaml /openapi.yaml get /models
openapi: 3.1.0
info:
  title: varg API
  version: 2.0.0
  description: |
    Unified REST API for AI media generation at `api.varg.ai/v2`.

    One API key, ~80 models across 8 providers, async jobs, stable output URLs
    on `s3.varg.ai`, files with lineage, and transparent credit billing
    (1 credit = 1 cent = $0.01).

    **The async job pattern:** every generation request returns `202 Accepted`
    with a job object (`status: queued`). Poll `GET /jobs/{id}` until the job
    reaches a terminal status (`completed`, `failed`, or `cancelled`), then read
    `output.outputs[0].url`. Alternatively, set `options.webhook_url` in the
    request to receive an HMAC-signed callback when the job finishes.
servers:
  - url: https://api.varg.ai/v2
security:
  - bearerAuth: []
tags:
  - name: Generation
    description: >-
      Create generation jobs (image, video, speech, music, transcription,
      ffmpeg, render, pipeline)
  - name: Tools
    description: Discover tools, their schemas, and call any tool generically
  - name: Jobs
    description: Poll and manage job lifecycle
  - name: Files
    description: Upload, import, probe, and manage files
  - name: Folders
    description: Group files into folders and file generated output automatically
  - name: Lineage
    description: Resolve which job produced a file
  - name: Presets
    description: Browse and apply reusable parameter values — voices, styles
  - name: Templates
    description: Browse, publish, use and render community templates
  - name: Pricing
    description: Estimate costs and browse the price catalog
  - name: Billing
    description: Balance, usage, and transaction history
  - name: Analytics
    description: >-
      Spend, runs and files over time — summaries, time series, breakdowns,
      activity
  - name: Account
    description: Identity and API key management
paths:
  /models:
    get:
      tags:
        - Tools
      summary: List models
      description: |
        The public model catalogue: every canonical model with its provider
        routes, capability data, pricing rule and operational metadata. Auth is
        optional; models of the `pipeline` tool appear only for callers granted
        access to them. Pass a canonical name (auto-routing) or a route's
        `model_key` (exact route pinning) as `model` when creating jobs. Schemas
        are not inlined; follow each route's `schema_url`. Amounts are in cents.
      operationId: listModels
      parameters:
        - name: tool
          in: query
          schema:
            type: string
            example: video
          description: Only models of this tool (`image`, `video`, `speech`, ...).
      responses:
        '200':
          description: Model catalogue
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelCatalog'
              examples:
                video:
                  value:
                    version: '2026-10-01T12:00:00.000Z'
                    data:
                      - model: kling_v2_6
                        tool: video
                        display_name: Kling v2.6
                        description: Text and image to video
                        routes:
                          - model_key: fal:kling_v2_6/text_to_video
                            provider: fal
                            modality:
                              - text-to-video
                            output_type: video
                            description: null
                            priority: 1
                            accepts_files: false
                            pricing:
                              pricing_id: ppr_abc123
                              rule:
                                type: per_second_conditional
                              user_price_estimate_cents: 147
                              min_user_price_cents: 40
                            ops:
                              delivery: poll
                              poll_interval_ms: 10000
                              estimated_duration_ms: 90000
                              max_timeout_ms: 600000
                            schema_url: >-
                              /v2/tools/video?model=fal%3Akling_v2_6%2Ftext_to_video
      security:
        - {}
        - bearerAuth: []
components:
  schemas:
    ModelCatalog:
      type: object
      required:
        - version
        - data
      properties:
        version:
          type:
            - string
            - 'null'
          description: Change-detection token (latest update time across routes).
        data:
          type: array
          items:
            $ref: '#/components/schemas/ModelEntry'
    ModelEntry:
      type: object
      required:
        - model
        - tool
        - display_name
        - description
        - routes
      properties:
        model:
          type: string
          description: Canonical model name; pass as `model` for auto-routing.
          example: kling_v2_6
        tool:
          type: string
          example: video
        display_name:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        routes:
          type: array
          items:
            $ref: '#/components/schemas/ModelRoute'
    ModelRoute:
      type: object
      required:
        - model_key
        - provider
        - modality
        - output_type
        - description
        - priority
        - accepts_files
        - pricing
        - ops
        - schema_url
      properties:
        model_key:
          type: string
          description: Exact route address; pass as `model` to pin this route.
          example: fal:kling_v2_6/text_to_video
        provider:
          type: string
          example: fal
        modality:
          type:
            - array
            - 'null'
          items:
            type: string
          example:
            - text-to-video
        output_type:
          type:
            - string
            - 'null'
          example: video
        description:
          type:
            - string
            - 'null'
        priority:
          type: integer
          description: Auto-routing order; lower is preferred.
        accepts_files:
          type: boolean
          description: Whether the route maps the unified `files` input.
        pricing:
          type: object
          required:
            - pricing_id
            - rule
            - user_price_estimate_cents
            - min_user_price_cents
          properties:
            pricing_id:
              type:
                - string
                - 'null'
            rule:
              type:
                - object
                - 'null'
              additionalProperties: true
              description: Pricing rule (shape varies by `type`).
            user_price_estimate_cents:
              type:
                - number
                - 'null'
              description: Worst-case price in cents.
            min_user_price_cents:
              type:
                - number
                - 'null'
              description: Cheapest case price in cents, null when the rule has no minimum.
        ops:
          type: object
          required:
            - delivery
            - poll_interval_ms
            - estimated_duration_ms
            - max_timeout_ms
          properties:
            delivery:
              type:
                - string
                - 'null'
              example: poll
            poll_interval_ms:
              type:
                - integer
                - 'null'
            estimated_duration_ms:
              type:
                - integer
                - 'null'
            max_timeout_ms:
              type:
                - integer
                - 'null'
        schema_url:
          type: string
          description: >-
            Path (relative to the API origin) of the input schema for this
            route.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        varg API key (`varg_...`). Get one at [app.varg.ai](https://app.varg.ai)
        or run `bunx vargai login`. App sessions may alternatively send a
        Supabase JWT.

````

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