> ## 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 presets

> Browse the preset catalogue: reusable parameter values you cannot guess
(voice ids, style ids). Auth is optional; a Bearer token additionally
includes the account's private presets. Any query parameter other than
`type`, `namespace`, `tool`, `q` and `limit` is treated as a metadata
filter (for example `?gender=male&tone=deep`); discover the available
axes with `GET /presets/filters`. List items carry no `tools` fragments;
fetch `GET /presets/{id}` for those.




## OpenAPI

````yaml /openapi.yaml get /presets
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:
  /presets:
    get:
      tags:
        - Presets
      summary: List presets
      description: |
        Browse the preset catalogue: reusable parameter values you cannot guess
        (voice ids, style ids). Auth is optional; a Bearer token additionally
        includes the account's private presets. Any query parameter other than
        `type`, `namespace`, `tool`, `q` and `limit` is treated as a metadata
        filter (for example `?gender=male&tone=deep`); discover the available
        axes with `GET /presets/filters`. List items carry no `tools` fragments;
        fetch `GET /presets/{id}` for those.
      operationId: listPresets
      parameters:
        - name: type
          in: query
          schema:
            type: string
            example: voice
          description: Filter by parameter type (for example `voice`, `style`).
        - name: namespace
          in: query
          schema:
            type: string
            example: elevenlabs
          description: >-
            Filter by the id system that minted the value (for example
            `elevenlabs`, `higgsfield`, `fal`).
        - name: tool
          in: query
          schema:
            type: string
            example: speech
          description: Only presets that can be delivered into this tool.
        - name: q
          in: query
          schema:
            type: string
          description: Free-text search over name and description.
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            maximum: 200
          description: >-
            Max results. Values above 200 are clamped; invalid values fall back
            to 50.
      responses:
        '200':
          description: Matching presets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresetListResponse'
              examples:
                voices:
                  value:
                    count: 21
                    data:
                      - id: preset_5f4dcc3b5aa7
                        kind: provider_value
                        type: voice
                        namespace: elevenlabs
                        name: Brian
                        description: Deep, professional male voice
                        preview_url: https://s3.varg.ai/presets/voice/brian.mp3
                        metadata:
                          gender: male
                          tone:
                            - deep
                            - professional
                        status: active
      security:
        - {}
        - bearerAuth: []
components:
  schemas:
    PresetListResponse:
      type: object
      required:
        - count
        - data
      properties:
        count:
          type: integer
          description: Total number of matches, before `limit` is applied.
        data:
          type: array
          items:
            $ref: '#/components/schemas/PresetListItem'
    PresetListItem:
      type: object
      required:
        - id
        - kind
        - type
        - namespace
        - name
        - description
        - preview_url
        - metadata
        - status
      properties:
        id:
          type: string
          description: Canonical preset reference (`preset_<12hex>`).
          example: preset_5f4dcc3b5aa7
        kind:
          type: string
          description: Preset layer. Currently always `provider_value`.
          example: provider_value
        type:
          type: string
          description: Which parameter the preset fills (for example `voice`, `style`).
          example: voice
        namespace:
          type: string
          description: >-
            Whose id system minted the value (for example `elevenlabs`,
            `higgsfield`, `fal`).
          example: elevenlabs
        name:
          type: string
          example: Brian
        description:
          type:
            - string
            - 'null'
        preview_url:
          type:
            - string
            - 'null'
          description: Sample audio or image for the preset.
        metadata:
          type: object
          additionalProperties: true
          description: >-
            Filterable attributes. Keys vary by type; values are strings or
            arrays of strings.
        status:
          type: string
          enum:
            - active
            - deprecated
  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.