Skip to content
Hayonix

API reference · Schema

DownloadLink

A short-lived link to one download (valid 5 minutes), bound to one object of the caller's project

  • objectstringrequired

    Always `download_link`: the type of this object

    One ofdownload_link

  • urlstringrequired

    Absolute URL of the download; works without credentials until `expires_at`

  • pathstringrequired

    The same link relative to the API origin (`/v1/downloads?token=…`)

  • filenamestringrequired

    The name the download is saved under

  • bytesintegerrequired

    Size in bytes

  • expires_atstring (date-time)required

    When it expires (null: never) (ISO 8601, UTC)

Example
{
  "object": "download_link",
  "url": "https://api.example.com/v1/downloads?token=dl1.eyJr….Zm9v",
  "path": "string",
  "filename": "string",
  "bytes": 1,
  "expires_at": "2026-01-01T00:00:00.000Z"
}

Used by