Roblox.Thumbnails.Apis.Models.ThumbnailBatchRequest — openapi

Properties

Name	Type	Required	Description
requestId	string	false	The request id. (Generated client side, used to represent the items in the request)
targetId	integer	false	The thumbnail target id
token	string	false	Alternative ase token used to identify a thumbnail
alias	string	false	Alternative string used to identify a thumbnail instead of targetId
type	string	false	The type of the thumbnails ['Avatar' = 1, 'AvatarHeadShot' = 2, 'GameIcon' = 3, 'BadgeIcon' = 4, 'GameThumbnail' = 5, 'GamePass' = 6, 'Asset' = 7, 'BundleThumbnail' = 8, 'Outfit' = 9, 'GroupIcon' = 10, 'DeveloperProduct' = 11, 'AvatarBust' = 12, 'AutoGeneratedAsset' = 13, 'PlaceIcon' = 14, 'AutoGeneratedGameIcon' = 15, 'ForceAutoGeneratedGameIcon' = 16, 'Look' = 17, 'CreatorContextAsset' = 18, 'Screenshot' = 19]
size	string	false	The thumbnail size
format	string	false	The thumbnail format
isCircular	boolean	false	Is the thumbnail circular shape
accessContext	string	false	Access context for asset permission checks (only relevant for Asset thumbnail types)
headShape	string	false	Head shape for dynamic head thumbnails (only relevant for Asset thumbnail types with dynamic head)
includeBackground	boolean	false	Whether to include a background in avatar thumbnails (defaults to false)
includeProfileFrame	boolean	false	Whether to composite the user's equipped profile frame into the thumbnail (defaults to false). When true the returned image has the frame baked in server-side.

Complete Schema

{
  "type": "object",
  "properties": {
    "requestId": {
      "description": "The request id. (Generated client side, used to represent the items in the request)",
      "type": "string"
    },
    "targetId": {
      "format": "int64",
      "description": "The thumbnail target id",
      "type": "integer"
    },
    "token": {
      "description": "Alternative ase token used to identify a thumbnail",
      "type": "string"
    },
    "alias": {
      "description": "Alternative string used to identify a thumbnail\ninstead of targetId",
      "type": "string"
    },
    "type": {
      "description": "The type of the thumbnails ['Avatar' = 1, 'AvatarHeadShot' = 2, 'GameIcon' = 3, 'BadgeIcon' = 4, 'GameThumbnail' = 5, 'GamePass' = 6, 'Asset' = 7, 'BundleThumbnail' = 8, 'Outfit' = 9, 'GroupIcon' = 10, 'DeveloperProduct' = 11, 'AvatarBust' = 12, 'AutoGeneratedAsset' = 13, 'PlaceIcon' = 14, 'AutoGeneratedGameIcon' = 15, 'ForceAutoGeneratedGameIcon' = 16, 'Look' = 17, 'CreatorContextAsset' = 18, 'Screenshot' = 19]",
      "enum": [
        "Avatar",
        "AvatarHeadShot",
        "GameIcon",
        "BadgeIcon",
        "GameThumbnail",
        "GamePass",
        "Asset",
        "BundleThumbnail",
        "Outfit",
        "GroupIcon",
        "DeveloperProduct",
        "AvatarBust",
        "AutoGeneratedAsset",
        "PlaceIcon",
        "AutoGeneratedGameIcon",
        "ForceAutoGeneratedGameIcon",
        "Look",
        "CreatorContextAsset",
        "Screenshot"
      ],
      "type": "string"
    },
    "size": {
      "description": "The thumbnail size",
      "type": "string"
    },
    "format": {
      "description": "The thumbnail format",
      "type": "string"
    },
    "isCircular": {
      "description": "Is the thumbnail circular shape",
      "type": "boolean"
    },
    "accessContext": {
      "description": "Access context for asset permission checks (only relevant for Asset thumbnail types)",
      "type": "string"
    },
    "headShape": {
      "description": "Head shape for dynamic head thumbnails (only relevant for Asset thumbnail types with dynamic head)",
      "type": "string"
    },
    "includeBackground": {
      "description": "Whether to include a background in avatar thumbnails (defaults to false)",
      "type": "boolean"
    },
    "includeProfileFrame": {
      "description": "Whether to composite the user's equipped profile frame into the thumbnail (defaults to false).\nWhen true the returned image has the frame baked in server-side.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}