v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB
Thumbnails

Returns a list of thumbnails with varying types and sizes

post/v1/batch

Headers

Roblox-Place-Idinteger

(optional) placeid

Request body

requestIdstring

The request id. (Generated client side, used to represent the items in the request)

targetIdinteger

The thumbnail target id

tokenstring

Alternative ase token used to identify a thumbnail

aliasstring

Alternative string used to identify a thumbnail instead of targetId

type'Avatar' | 'AvatarHeadShot' | 'GameIcon' | 'BadgeIcon' | 'GameThumbnail' | 'GamePass' | 'Asset' | 'BundleThumbnail' | 'Outfit' | 'GroupIcon' | 'DeveloperProduct' | 'AvatarBust' | 'AutoGeneratedAsset' | 'PlaceIcon' | 'AutoGeneratedGameIcon' | 'ForceAutoGeneratedGameIcon' | 'Look' | 'CreatorContextAsset' | 'Screenshot'

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]

sizestring

The thumbnail size

formatstring

The thumbnail format

isCircularboolean

Is the thumbnail circular shape

accessContextstring

Access context for asset permission checks (only relevant for Asset thumbnail types)

headShapestring

Head shape for dynamic head thumbnails (only relevant for Asset thumbnail types with dynamic head)

includeBackgroundboolean

Whether to include a background in avatar thumbnails (defaults to false)

Response

OK