API reference · Model references
Accept a model reference (checked against the model hub, pinned to a commit)
/v1/model-references- TypeScript
client.modelReferences.create()- Python
client.model_references.create()- CLI
hayonix model-references create
Checks a model on the model hub and records it for this project: the revision is pinned to its commit, and the files (all, or those matching include) are listed with their sizes and digests. Nothing is downloaded now; hosts download and verify the files when a workload that mounts the reference starts. A private or gated model needs token_secret_id; its files are then cached for this project only.
Project API key (Authorization: Bearer sk_…), or a console session. Requires the model_reference:create permission (a key's scope, or a role that includes it).
Examples
The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.
curl -sS "$API_BASE_URL/model-references" \
-H "Authorization: Bearer $API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"model": "hf-internal-testing/tiny-random-gpt2@main",
"include": [
"*.json",
"*.safetensors"
]
}'Request
| Header | Required | Description |
|---|---|---|
Authorization | yes | Bearer and your API key. The key implies its project. |
X-Project-Id | session only | The project to act in, for console sessions. Requests with an API key leave it out. |
Idempotency-Key | no | Makes a retry safe: the same key and request within 24 hours return the original response (see Idempotency). The SDKs send one for you. |
Body
JSON (application/json): 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_
Response
201 ModelReference — What the reference resolved to
objectstringrequiredAlways `model_reference`: the type of this object
One of
model_referenceidstringrequiredUnique ID (`mrf_…`)
ID with prefix mrf_
repositorystringrequiredThe repository on the model hub, as <owner>/<name>
requested_revisionstringrequiredThe branch, tag or commit the reference named when it was accepted
commitstringrequiredThe 40-character commit the revision resolved to
includearray of stringrequiredThe file patterns it was limited to (empty: every file)
visibilitystringrequiredprivate: fetched with token_secret_id and cached on hosts for this project only
One of
publicprivatetoken_secret_idstring | nullrequiredID of the token secret
file_countintegerrequiredHow many files it holds
total_bytesintegerrequiredThe size of all its files together, in bytes
Every file, with the size and digest each is verified against on the host
ShowHide 4 fields of
filespathstringrequiredPath of the file inside the repository
sizeintegerrequiredSize of the file in bytes
sha256string | nullrequiredLarge files: SHA-256 of the content
git_blob_sha1string | nullrequiredSmall files: the version-control object ID
mount_pathstringrequiredWhere it appears in a container: the cache layout the model hub client libraries read, so they find it with networking off
snapshot_pathstringrequiredThe directory holding its files inside a container
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
Example response
{
"object": "model_reference",
"id": "mrf_01jc5zq4m8k3v6x9t2w7r0b1e4",
"repository": "hf-internal-testing/tiny-random-gpt2",
"requested_revision": "string",
"commit": "string",
"include": [
"string"
],
"visibility": "public",
"token_secret_id": "string",
"file_count": 1,
"total_bytes": 1,
"files": [
{
"path": "string",
"size": 1,
"sha256": "string",
"git_blob_sha1": "string"
}
],
"mount_path": "/model-cache/models--hf-internal-testing--tiny-random-gpt2",
"snapshot_path": "string",
"created_at": "2026-01-01T00:00:00.000Z"
}Errors
Errors use the standard envelope. What this operation can answer:
| Status | Type | When |
|---|---|---|
400 | invalid_request_error | A parameter or body field is missing or not allowed; param names it. |
401 | authentication_error | The key or session is missing, revoked or expired. |
403 | permission_error | The credential lacks the permission this needs, or the organization is suspended. |
409 | conflict_error idempotency_in_progress | A request with the same Idempotency-Key is still running. |
422 | idempotency_error idempotency_key_reused | The Idempotency-Key was used with a different request. |
429 | rate_limit_error rate_limited | Too many requests; retry after retry-after seconds. |