v22

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

Get a model's README

Get the README content for a model.

Example cURL request:

curl -s \
  -H "Authorization: Bearer $REPLICATE_API_TOKEN" \
  https://api.replicate.com/v1/models/replicate/hello-world/readme

The response will be the README content as plain text in Markdown format:

# Hello World Model

This is an example model that...

get/models/{model_owner}/{model_name}/readme

model_ownerstring required

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

model_namestring required

The name of the model.

Success