---
title: "Update metadata for a model"
method: PATCH
path: "/models/{model_owner}/{model_name}"
---

# Update metadata for a model

`PATCH /models/{model_owner}/{model_name}`

Update select properties of an existing model.

You can update the following properties:

  - `description` - Model description
  - `readme` - Model README content
  - `github_url` - GitHub repository URL
  - `paper_url` - Research paper URL
  - `weights_url` - Model weights URL
  - `license_url` - License URL

Example cURL request:

```console
curl -X PATCH \
  https://api.replicate.com/v1/models/your-username/your-model-name \
  -H "Authorization: Token $REPLICATE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Detect hot dogs in images",
    "readme": "# Hot Dog Detector\n\n🌭 Ketchup, mustard, and onions...",
    "github_url": "https://github.com/alice/hot-dog-detector",
    "paper_url": "https://arxiv.org/abs/2504.17639",
    "weights_url": "https://huggingface.co/alice/hot-dog-detector",
    "license_url": "https://choosealicense.com/licenses/mit/"
  }'
```

The response will be the updated model object with all of its properties.

## Path parameters

- `model_owner` string, required
- `model_name` string, required

## Request body

- object
  - `description` string — A description of the model.
  - `github_url` string — A URL for the model's source code on GitHub.
  - `license_url` string — A URL for the model's license.
  - `paper_url` string — A URL for the model's paper.
  - `readme` string — The README content of the model.
  - `weights_url` string — A URL for the model's weights.

## Response `200`

Success

- SchemasModelResponse
  - `cover_image_url` string, uri, nullable — A URL for the model's cover image
  - `default_example` object, nullable — The model's default example prediction
  - `description` string, nullable — A description of the model
  - `github_url` string, uri, nullable — A URL for the model's source code on GitHub
  - `is_official` boolean — Boolean indicating whether the model is officially maintained by Replicate. Official models are always on, have stable API interfaces, and predictable pricing.
  - `latest_version` object, nullable — The model's latest version
  - `license_url` string, uri, nullable — A URL for the model's license
  - `name` string — The name of the model
  - `owner` string — The name of the user or organization that owns the model
  - `paper_url` string, uri, nullable — A URL for the model's paper
  - `run_count` integer — The number of times the model has been run
  - `url` string, uri — The URL of the model on Replicate
  - `visibility` 'public' | 'private' — Whether the model is public or private

---

[API](https://skmtc.net/replicate/apis/replicate-http-api.md) · [All operations](https://skmtc.net/replicate/apis/replicate-http-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/replicate/replicate-http-api/versions/7a537f433b0b/schema)