Skip to content
Hayonix

API reference · Schema

ModelReference

  • objectstringrequired

    Always `model_reference`: the type of this object

    One ofmodel_reference

  • idstringrequired

    Unique ID (`mrf_…`)

    ID with prefix mrf_

  • repositorystringrequired

    The repository on the model hub, as <owner>/<name>

  • requested_revisionstringrequired

    The branch, tag or commit the reference named when it was accepted

  • commitstringrequired

    The 40-character commit the revision resolved to

  • includearray of stringrequired

    The file patterns it was limited to (empty: every file)

  • visibilitystringrequired

    private: fetched with token_secret_id and cached on hosts for this project only

    One ofpublicprivate

  • token_secret_idstring | nullrequired

    ID of the token secret

  • file_countintegerrequired

    How many files it holds

  • total_bytesintegerrequired

    The size of all its files together, in bytes

  • Every file, with the size and digest each is verified against on the host

    Show 4 fields of files
    • pathstringrequired

      Path of the file inside the repository

    • sizeintegerrequired

      Size of the file in bytes

    • sha256string | nullrequired

      Large files: SHA-256 of the content

    • git_blob_sha1string | nullrequired

      Small files: the version-control object ID

  • mount_pathstringrequired

    Where it appears in a container: the cache layout the model hub client libraries read, so they find it with networking off

  • snapshot_pathstringrequired

    The directory holding its files inside a container

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

Example
{
  "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"
}

Used by