Ctrlk
Login to HIVO
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Assets

List assets

get
Authorizations
X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Query parameters
sortstring · enumOptional

Sort key. Allowed values are createdAt, -createdAt. Defaults to -createdAt.

Default: -createdAtPossible values:
limitinteger · min: 1 · max: 256Optional

Maximum number of assets to return (1–256). Defaults to 32.

Default: 32
skipinteger · max: 65536Optional

Number of assets to skip (pagination) (0–65536). Defaults to 0.

Default: 0
includeThumbnailsbooleanOptional

When true, each listed asset may include a short‑lived signed thumbnail link under links.thumbnail. The thumbnail link is a JSON:API link object with href and meta.version.

Example: false
filter[search]string · max: 256Optional

General search string (max 256 chars). Prefix‑matches asset name and tags (case‑insensitive).

Example: logo
filter[id]string[]Optional

Asset ID filter. May be repeated and/or provided as a comma‑separated list. Max 512 IDs.

Example: ["5abc234abc234abc2"]
filter[path]string · max: 512Optional

Exact path match (max 512 chars). When combined with filter[collectionId], matches collection‑scoped paths.

Example: Parent/New Folder/
filter[pathPrefix]string · max: 512Optional

Path prefix match (max 512 chars). When combined with filter[collectionId], matches collection‑scoped prefixes.

Example: Parent/
filter[sensitive]booleanOptional

Filters by sensitive status. May require additional permissions.

Example: false
filter[archived]booleanOptional

true returns archived assets; false (default) returns non‑archived. May require additional permissions.

Example: false
filter[licenseExpired]booleanOptional

Filters assets with expired licenses. May require additional permissions.

Example: false
filter[approved]booleanOptional

Filters by approval status.

Example: true
filter[favoriteBy]stringOptional

User ID who favorited the asset (ObjectId).

Example: 2abc234abc234abc2
filter[collectionId]stringOptional

Collection ID to filter within (ObjectId).

Example: 4abc234abc234abc2
filter[clientId]stringOptional

Admin‑only. Client ID to filter within (ObjectId).

Example: 7abc234abc234abc2
filter[batchId]string · max: 256Optional

Batch identifier (max 256 chars).

Example: f376KgcmmDBnb793A.1771479603
filter[createdMin]integerOptional

Created at (Unix seconds) lower bound.

Example: 1714521600
filter[createdMax]integerOptional

Created at (Unix seconds) upper bound.

Example: 1717200000
filter[sku]string · max: 128Optional

SKU (max 128 chars).

Example: SKU-123
filter[metadata.KEY]stringOptional

Metadata filter for arbitrary keys. Replace KEY with the metadata key you wish to filter on. Value is matched case‑insensitively.

Example: blue
Responses
200

OK

application/json
get/v1/assets
GET /api/rest/v1/assets HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "timestamp": 1,
    "authentication": "text",
    "links": {
      "me": "https://example.com"
    }
  },
  "links": {
    "self": "https://example.com",
    "first": "https://example.com",
    "prev": "https://example.com",
    "next": "https://example.com"
  },
  "data": [
    {
      "type": "assets",
      "id": "text",
      "attributes": {
        "name": "text",
        "createdAt": 1,
        "lastModified": 1,
        "tags": [
          "text"
        ],
        "versions": {
          "ANY_ADDITIONAL_PROPERTY": {
            "size": 1,
            "type": "text",
            "extension": "text"
          }
        },
        "collectionIds": [
          "text"
        ],
        "collections": [
          {}
        ],
        "skus": [
          "text"
        ],
        "path": "text",
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "views": 1,
        "downloads": 1,
        "clientId": "text",
        "createdBy": "text",
        "sensitiveAt": 1,
        "expires": 1,
        "licenseExpiresAt": 1,
        "batchId": "text",
        "favs": [
          "text"
        ],
        "approvedAt": 1,
        "taskIds": [
          "text"
        ],
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "links": {
        "self": "https://example.com",
        "thumbnail": {
          "href": "https://example.com",
          "meta": {
            "version": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Get asset

get
Authorizations
X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Path parameters
assetIdstringRequired

Asset ID

Example: 5abc234abc234abc2
Responses
200

OK

application/json
get/v1/assets/{assetId}
GET /api/rest/v1/assets/{assetId} HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "timestamp": 1,
    "authentication": "text",
    "links": {
      "me": "https://example.com"
    }
  },
  "links": {
    "self": "https://example.com",
    "thumbnail": {
      "href": "https://example.com",
      "meta": {
        "version": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "data": {
    "type": "assets",
    "id": "text",
    "attributes": {
      "name": "text",
      "createdAt": 1,
      "lastModified": 1,
      "tags": [
        "text"
      ],
      "versions": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "collectionIds": [
        "text"
      ],
      "collections": [
        {}
      ],
      "skus": [
        "text"
      ],
      "path": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "views": 1,
      "downloads": 1,
      "clientId": "text",
      "createdBy": "text",
      "sensitiveAt": 1,
      "expires": 1,
      "licenseExpiresAt": 1,
      "batchId": "text",
      "favs": [
        "text"
      ],
      "approvedAt": 1,
      "taskIds": [
        "text"
      ],
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "links": {
      "self": "https://example.com",
      "thumbnail": {
        "href": "https://example.com",
        "meta": {
          "version": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

Download asset version

get
Authorizations
X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Path parameters
assetIdstringRequired

Asset ID

Example: 5abc234abc234abc2
Query parameters
versionstringOptional

Version name to download. Defaults to original.

Default: original
attachmentstring · enumOptional

Set to 1 for Content‑Disposition attachment or 0 for inline.

Default: 1Possible values:
inlinestring · enumOptional

Inverse of attachment. Set to 1 for inline or 0 for attachment.

Default: 0Possible values:
Responses
302

Found. Redirect to a short‑lived S3 URL.

get/v1/assets/{assetId}/download
GET /api/rest/v1/assets/{assetId}/download HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

No content
PreviousUsersNextCollections

Last updated