v22

latestOpenAPI 3.1.0raw.githubusercontent.com2025-10-15361989.5 KB

Update metadata for a model

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:

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.

patch/models/{model_owner}/{model_name}

Path parameters

model_ownerstring required

The name of the user or organization that owns the model.

model_namestring required

The name of the model.

Request body

descriptionstring

A description of the model.

github_urlstring

A URL for the model's source code on GitHub.

license_urlstring

A URL for the model's license.

paper_urlstring

A URL for the model's paper.

readmestring

The README content of the model.

weights_urlstring

A URL for the model's weights.

Example request

{
  "description": "Detect hot dogs in images",
  "github_url": "https://github.com/alice/hot-dog-detector",
  "paper_url": "https://arxiv.org/abs/2504.17639",
  "readme": "# Updated README\n\nNew content here",
  "weights_url": "https://huggingface.co/alice/hot-dog-detector"
}

Response

Success

cover_image_urlstring uri nullable

A URL for the model's cover image

default_exampleobject nullable

The model's default example prediction

descriptionstring nullable

A description of the model

github_urlstring uri nullable

A URL for the model's source code on GitHub

is_officialboolean

Boolean indicating whether the model is officially maintained by Replicate. Official models are always on, have stable API interfaces, and predictable pricing.

latest_versionobject nullable

The model's latest version

license_urlstring uri nullable

A URL for the model's license

namestring

The name of the model

ownerstring

The name of the user or organization that owns the model

paper_urlstring uri nullable

A URL for the model's paper

run_countinteger

The number of times the model has been run

urlstring uri

The URL of the model on Replicate

visibility'public' | 'private'

Whether the model is public or private