Asset Data Model

Files, images, videos, and audio uploaded and imported into the site for use within content and the theme.

This resource is a part of the Uploading Assets Workflow.

Sample JSON Data

      {
        "data": {
          "id" "7f936e17-65c3-413f-b19d-a28a89ebc467",
          "type": "assets",
          "attributes": {
            "title": null,
            "content-type": "image/png",
            "type": null,
            "subtype": null,
            "keywords": null,
            "description": null,
            "theme-path": null,
            "created-at": "2012-04-23T18:25:43.511Z",
            "updated-at": "2012-04-23T18:25:43.511Z"
          },
          "relationships": {
            "asset": {
              "data": {
                "id": "4e81e992-ff4f-41ae-961a-6fa93dbd9cae",
                "type": "asset-uploads"
              }
            }
          }
        }
      }

Attributes

Attribute Type Required Description
title string No Title for referencing the asset. If none is provided, it is recommended to use the name of the file.
content-type string Read-only MIME type of asset file.
type string Read-only General type of file. Will have values of image, video, document, audio, font, zip_archive, file, or null if a type wasn’t identified. See Asset Types API Endpoint for more information.
subtype string Read-only Specific type of file. Value will depend on value of type. See Asset Types API Endpoint for more information.
keywords string No Keywords to describe asset and to aid in search.
description string No Description and notes about asset.
theme-path string Read-only If this asset was uploaded along with a theme, this value will be populated with the path to the file from the theme’s assets folder.
created-at date Read-only Records when asset record was created, localized to the current logged in user’s time zone.
updated-at date Read-only Records when asset record last updated, localized to the current logged in user’s time zone.

Relationships

Title Type Required Description
asset object Read-only Upload, import, or file associated with this asset record. Can be an image or upload.

Related