---
title: "Models - get parameter definitions"
method: GET
path: "/api/v1/models/{modelName}/params"
tags: ["Models"]
---

# Models - get parameter definitions

`GET /api/v1/models/{modelName}/params`

Returns parameter schema, types, defaults, and limits for the specified model.

## Path parameters

- `modelName` string, required

## Response `200`

Model definition

- ModelDefinitionResponse — Success envelope containing a single model's definition
  - `ok` true, required
  - `data` ModelDefinition, required — Full definition of a parametric model including all parameters and their constraints
    - `name` string, required — Model slug used in API paths (e.g. 'dragon-cup')
    - `displayName` string, required — Human-friendly model name for UI display
    - `description` string, required — What this model creates and its key characteristics
    - `params` ModelParamDefinition[], required — All accepted parameters with types, descriptions, and defaults
      - `name` string, required — Parameter name as used in the request body
      - `type` 'number' | 'integer' | 'boolean' | 'array', required — Data type of a model parameter: 'number' (float), 'integer' (whole number), 'boolean' (true/false), 'array' (list of values)
      - `description` string, required — Human-readable explanation of what this parameter controls
      - `default` unknown, required
      - `items` object — Element type descriptor (only present for array parameters)
        - `type` string, required
    - `defaults` object, required — Complete default parameter values map

## Other responses

- `404` — Not found

---

[API](https://skmtc.dev/bitbybit-dev/apis/bitbybit-cad-cloud-api.md) · [All operations](https://skmtc.dev/bitbybit-dev/apis/bitbybit-cad-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bitbybit-dev/bitbybit-cad-cloud-api/revisions/1135d4473bc2/schema)
