---
title: "GET /v1/engines"
method: GET
path: "/v1/engines"
tags: ["Engines"]
---

# GET /v1/engines

`GET /v1/engines`

## Request

- Base URL: `https://api.virtuall.pro`
- URL: `https://api.virtuall.pro/v1/engines`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

Lists the non-deprecated generation engines available to the authenticated user. Model Library resource IDs use the public `model-library/` namespace. Parameter constraints and option lists are omitted when not applicable.

## Response `200`

List of available engines

- EnginePage
  - `data` Engine[], required
    - `id` string, required: Stable catalogue identifier. For Model Library entries, submit this value as `model`; first-party engines use their `name` as `model`. Model Library identifiers use the `model-library/` namespace.
    - `name` string, required
    - `external` boolean, required: True for a studio-enabled Model Library entry; false for a first-party engine.
    - `status` string, required
    - `description` string, nullable
    - `type` string, required
    - `output` string[]
    - `maxOutputs` integer
    - `inputs` EngineInput[], required
      - `id` string, required: Stable public input identifier. Model Library identifiers use the `model-library/` namespace.
      - `key` string, required: Stable mode selector submitted as `mode` in `POST /v1/generations`.
      - `name` string, required
      - `type` string, required
      - `stage` string
      - `params` EngineParameter[]
        - `id` string, required: Stable public parameter identifier. Model Library identifiers use the `model-library/` namespace.
        - `key` string, required: Stable parameter key submitted as a property of `params` in `POST /v1/generations`.
        - `label` string, required
        - `type` string, required
        - `placeholder` string, nullable
        - `defaultValue` string, nullable
        - `min` number: Minimum accepted value. Omitted when not applicable.
        - `max` number: Maximum accepted value. Omitted when not applicable.
        - `step` number: Accepted value increment. Omitted when not applicable.
        - `options` string[]: Allowed values for a fixed-choice parameter. Omitted when no fixed option list applies.
      - `references` string[]
      - `maxReferences` integer[]
      - `imageAspectRatio` EngineImageAspectRatio
        - `min` number, required
        - `max` number, required
      - `maxOutputs` integer

## Other responses

- `400`: Invalid request
- `401`: Authentication required or invalid
- `403`: Permission denied
- `404`: Resource unavailable or API feature disabled
- `429`: Rate limit exceeded
- `500`: Unexpected server error
- `503`: Service temporarily unavailable

---

[API](https://skmtc.dev/virtuall/apis/virtuall-external-api.md) - [All operations](https://skmtc.dev/virtuall/apis/virtuall-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/virtuall/apis/virtuall-external-api/revisions/2b3a30238ce0?raw)