---
title: "Update model metadata"
method: PATCH
path: "/api/v1/models/{modelId}"
tags: ["Models"]
---

# Update model metadata

`PATCH /api/v1/models/{modelId}`

## Request

- Base URL: `https://numonic.ai`
- URL: `https://numonic.ai/api/v1/models/{modelId}`
- Auth: API key in header `x-api-key`

Update editable metadata fields for a model. Only provided fields are changed; omitted fields are left unchanged. Set a field to `null` to clear it.

## Path parameters

- `modelId` string, required: Model SHA-1 hash identifier

## Request body

- object
  - `display_name` string, nullable: Human-friendly display name
  - `description` string, nullable: Freeform model description
  - `trigger_words` string[], nullable: Trigger words that activate the model in a prompt
  - `recommended_weight` number, nullable: Recommended weight/strength for this model
  - `external_url` string, uri, nullable: Link to the model's source page (e.g., CivitAI, Hugging Face)

## Response `200`

Updated model details

- object
  - `data` ModelDetail, required: Full model record including version history
    - `model` string, required: SHA-1 hash identifying this model
    - `model_id` string, uuid, nullable: Optional UUID identifier
    - `name` string, required: Canonical model name
    - `display_name` string, nullable: Human-friendly display name
    - `model_type` string, nullable: Model type (lora, checkpoint, unet, etc.)
    - `base_model` string, nullable: Base model family (flux, sdxl, etc.)
    - `recommended_weight` number, nullable: Recommended weight/strength
    - `trigger_words` string[], nullable: Trigger words for prompt activation
    - `external_url` string, uri, nullable: Source page URL
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `asset_usage_count` integer, required: Number of assets generated with this model
    - `description` string, nullable: Freeform model description
    - `is_active` boolean, required
    - `versions` ModelVersion[], required
      - `version_tag` string, required: Version identifier
      - `version_notes` string, nullable
      - `training_steps` integer, nullable
      - `quality_score` number, nullable
      - `is_recommended` boolean, required
      - `trained_at` string, date-time, nullable
      - `load_date` string, date-time, required
    - `preview_count` integer, required: Number of preview images available

## Other responses

- `400`: Invalid modelId or request body
- `401`: Unauthorized
- `404`: Model not found or tenant mismatch

---

[API](https://skmtc.dev/numonic/apis/numonic-api.md) · [All operations](https://skmtc.dev/numonic/apis/numonic-api/llms.txt) · [OpenAPI document](https://skmtc.dev/numonic/apis/numonic-api/revisions/6c559bef1e35?raw)