> ## Documentation Index
> Fetch the complete documentation index at: https://vastai-80aa3a82-auto-openapi-update-8483c1e9.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List Workergroups

> Returns all active workergroups belonging to the authenticated user; alias for GET /api/v0/autojobs/.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/v0/workergroups/
openapi: 3.1.0
info:
  title: Vast.ai API
  description: >-
    Vast.ai REST API for managing GPU cloud instances, machine operations, and
    AI/ML workflows.


    ## AI Agent Quick-Start


    Install the CLI skill for your agent (Claude Code, Cursor, Windsurf, etc.):
      npx skills add vast-ai/vast-cli

    CLI reference:
    https://raw.githubusercontent.com/vast-ai/vast-cli/master/vastai/SKILL.md

    SDK reference:
    https://raw.githubusercontent.com/vast-ai/vast-cli/master/vastai_sdk/SKILL.md


    ## Auth

    All endpoints require `Authorization: Bearer $VAST_API_KEY`.

    Get your key at: https://cloud.vast.ai/manage-keys/


    ## Key Quirks

    - `gpu_ram` in CLI = GB; in REST API = MB (CLI auto-converts)

    - SSH keys must be registered BEFORE creating an instance (VM: no recovery;
    Docker: can add post-create)

    - `onstart` field is limited to 4048 characters -- gzip+base64 for longer
    scripts

    - `POST /api/v0/asks/{id}/` (create instance) returns `new_contract` as the
    instance ID, not `id`

    - Poll trap: if `actual_status` becomes `exited`, `unknown`, or `offline` it
    will never reach `running` -- destroy and retry
  version: 1.0.0
  contact:
    name: Vast.ai Support
    url: https://discord.gg/vast
servers:
  - url: https://console.vast.ai
    description: Production server
security:
  - BearerAuth: []
paths:
  /api/v0/workergroups/:
    get:
      tags:
        - Serverless
      summary: List Workergroups
      description: >-
        Returns all active workergroups belonging to the authenticated user;
        alias for GET /api/v0/autojobs/.
      responses:
        '200':
          description: >-
            Returns {success: true, results: [{id, min_load, target_util,
            cold_mult, cold_workers, template_hash, template_id, search_query,
            launch_args, gpu_ram, endpoint_name, endpoint_id, api_key,
            created_at, user_id}, ...]}
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always true on success.
                  results:
                    type: array
                    description: >-
                      List of workergroup objects with fields: id, min_load,
                      target_util, cold_mult, cold_workers, template_hash,
                      template_id, search_query, launch_args, gpu_ram,
                      endpoint_name, endpoint_id, api_key, created_at, user_id.
                    items:
                      type: object
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key must be provided in the Authorization header

````