API reference · Schema
CreateModelReferenceRequest
modelstringrequiredThe model on the model hub, as <owner>/<name> or <owner>/<name>@<revision>. The revision (a branch, tag or commit; default main) is pinned to its commit now, so a moving branch never changes what runs.
3–300 characters
includearray of stringOnly files matching one of these patterns (`*` matches any characters including "/", `?` one character). Default: every file of the revision.
up to 32 items
token_secret_idstring | nullA project secret holding a model hub access token, for private or gated repositories. Hosts download with it and keep the files for this project only; containers never see it.
ID with prefix sec_
Example
{
"model": "hf-internal-testing/tiny-random-gpt2@main",
"include": [
"*.json",
"*.safetensors"
]
}Used by
- Accept a model reference (checked against the model hub, pinned to a commit)
POST /v1/model-references