2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

Asset — toolbox-service/v1

Representation of an asset.

Properties

NameTypeRequiredDescription
idintegerfalseThe unique identifier of the asset.
namestringfalseThe name of the asset.
descriptionstringfalseThe description of the asset.
assetTypeIdintegerfalseThe type that the asset belongs to.
socialLinksarrayfalseThe social links associated with the asset.
previewAssetsfalseThe asset's preview asset ids grouped by asset type.
createTimestringfalseThe time the asset was created.
updateTimestringfalseThe time the asset was last updated.
categoryPathstringfalseCategory Path of the asset, if it exists. e.g. "3d__characters"

Complete Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The unique identifier of the asset.",
      "format": "int64"
    },
    "name": {
      "type": "string",
      "description": "The name of the asset.",
      "nullable": true
    },
    "description": {
      "type": "string",
      "description": "The description of the asset.",
      "nullable": true
    },
    "assetTypeId": {
      "type": "integer",
      "description": "The type that the asset belongs to.",
      "format": "int32",
      "nullable": true
    },
    "socialLinks": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SocialLinkModel"
      },
      "description": "The social links associated with the asset.",
      "nullable": true
    },
    "previewAssets": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PreviewAssetsModel"
        }
      ],
      "description": "The asset's preview asset ids grouped by asset type.",
      "nullable": true
    },
    "createTime": {
      "type": "string",
      "description": "The time the asset was created.",
      "format": "date-time",
      "nullable": true
    },
    "updateTime": {
      "type": "string",
      "description": "The time the asset was last updated.",
      "format": "date-time",
      "nullable": true
    },
    "categoryPath": {
      "type": "string",
      "description": "Category Path of the asset, if it exists.\r\ne.g. \"3d__characters\"",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Representation of an asset.",
  "nullable": true
}