Away 9:29 PM

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 — openapi

Represents an asset.

Properties

NameTypeRequiredDescription
assetTypestringfalseThe asset type. Required for Create Asset.
assetIdintegerfalseThe unique identifier of the asset. Required for Update Asset.
creationContext#/components/schemas/CreationContextfalse
descriptionstringfalseThe description of the asset. Limit to 1000 characters. Required for Create Asset.
displayNamestringfalseDisplay name of the asset. Required for Create Asset.
pathstringfalseThe returned resource path of the asset. Format: assets/{assetId}. Example: assets/2205400862.
revisionIdstringfalseRevision ID of the asset. Equivalent to versionNumber. Every change of the asset automatically commits a new version. The format is an integer string. Example: 1.
revisionCreateTimestringfalseThe creation timestamp of the current revision.
moderationResult#/components/schemas/ModerationResultfalse
iconstringfalseThe resource path for the icon.
previewsarrayfalseA list of previews, each with an asset path and alt text. Previews must be Image assets.
state#/components/schemas/Statefalse
socialLink#/components/schemas/SocialLinkfalse

Complete Schema

{
  "type": "object",
  "properties": {
    "assetType": {
      "type": "string",
      "description": "The asset type. Required for [Create Asset](#POST-v1-assets).",
      "format": "enum"
    },
    "assetId": {
      "type": "integer",
      "description": "The unique identifier of the asset. Required for [Update Asset](#PATCH-v1-assets-_asset_).",
      "format": "int64",
      "readOnly": true
    },
    "creationContext": {
      "$ref": "#/components/schemas/CreationContext"
    },
    "description": {
      "type": "string",
      "description": "The description of the asset. Limit to 1000 characters. Required for [Create Asset](#POST-v1-assets)."
    },
    "displayName": {
      "type": "string",
      "description": "Display name of the asset. Required for [Create Asset](#POST-v1-assets)."
    },
    "path": {
      "type": "string",
      "description": "The returned resource path of the asset. Format: `assets/{assetId}`. Example: `assets/2205400862`."
    },
    "revisionId": {
      "type": "string",
      "description": "Revision ID of the asset. Equivalent to `versionNumber`. Every change of the asset automatically commits a new version. The format is an integer string. Example: `1`.",
      "readOnly": true
    },
    "revisionCreateTime": {
      "type": "string",
      "description": "The creation timestamp of the current revision.",
      "format": "date-time",
      "readOnly": true
    },
    "moderationResult": {
      "$ref": "#/components/schemas/ModerationResult"
    },
    "icon": {
      "type": "string",
      "description": "The resource path for the icon."
    },
    "previews": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Preview"
      },
      "description": "A list of previews, each with an asset path and alt text. Previews must be **Image** assets."
    },
    "state": {
      "$ref": "#/components/schemas/State"
    },
    "socialLink": {
      "$ref": "#/components/schemas/SocialLink"
    }
  },
  "description": "Represents an asset."
}