The Asset Object

This is an object representing an asset in a space. Some properties can be read-only, and others can be managed by using the Management API or the UI.

Properties

• id number

  The numeric ID

• filename string

  Full path of the asset, including the file name

• space_id number

  Space ID in which the asset is connected

• created_at string

  Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

• updated_at string

  Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

• file object | null

  Represents a File object when uploading an asset. Returns null when retrieving asset details.

• asset_folder_id number

  Id of the folder containing this asset

• deleted_at string

  Deleted date (Format: YYYY-mm-dd HH:MM)

• short_filename string

  The file name of the asset

• content_type string

  The MIME type of the asset

• content_length number

  The content length in bytes

• alt string

  Alt text for the asset (default language)

• copyright string

  Copyright text for the asset (default language)

• title string

  Title of the asset (default language)

• source string

  Source text of the asset (default language)

• expire_at string

  Date when the asset should expire (Format: yyyy-MM-dd’T’HH:mm:ssZ)

• focus string

  The focus point of the image (Only for image assets)

• internal_tag_ids string[]

  List of ids of the tags assigned to the asset

• internal_tags_list object[]

  List of objects containing the details of tags used for the asset

  Show child properties

  • id number

    Id of the tag

  • name string

    Name of the tag

• locked boolean

  Defines if the asset is locked for any changes

• publish_at string

  Date when the asset should be made public (Format: yyyy-MM-dd’T’HH:mm:ssZ)

• is_private boolean

  Defines if the asset should be inaccessable to the public

• meta_data object

  Includes custom metadata fields for an asset along with the default ones. It also contains the translations of the same if added in the format metafield__i18n__langcode . This field should be used for updating the metadata including the default ones. (alt, title, source, copyright)

Example Object

{
   "id": 1520,
   "filename": "https://s3.amazonaws.com/a.storyblok.com/f/616/SIZE/UNIQUEIDENTIFIER/your_filename.jpg",
   "space_id": 123,
   "created_at": "2024-05-07T11:47:28.950Z",
   "updated_at": "2024-05-14T11:13:51.688Z",
   "file": null,
   "asset_folder_id": null,
   "deleted_at": null,
   "short_filename": "hero.jpeg",
   "content_length": 847195,
   "content_type": "image/jpeg",
   "permanently_deleted": false,
   "alt": "Alt text",
   "copyright": "",
   "title": "",
   "focus": "1964x892:1965x893",
   "ext_id": null,
   "expire_at": "2024-05-15T11:08:00.000Z",
   "source": "",
   "internal_tag_ids": [
       "33772"
   ],
   "locked": false,
   "is_private": true,
   "publish_at": null,
   "meta_data": {
       "alt": "alt text",
       "title": "image title",
       "source": "image source",
       "copyright": "CC",
       "alt__i18n__de": "Alt in german"
   },
   "internal_tags_list": [
       {
           "id": 33772,
           "name": "flower"
       }
   ]
}