Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
POST /v1/batch — openapi
Returns a list of thumbnails with varying types and sizes
Endpoint
Method: POST
Path: /v1/batch
Servers:
https://thumbnails.roblox.com
Parameters
| Name | Location | Required | Description |
|---|---|---|---|
| Roblox-Place-Id | header | false | (optional) placeid |
[
{
"in": "header",
"name": "Roblox-Place-Id",
"description": "(optional) placeid",
"schema": {
"type": "integer",
"format": "int64"
}
}
]Request Body
List of ThumbnailBatchRequest objects, may contain the following request types: 1. Avatar 2. AvatarHeadShot 3. GameIcon 4. BadgeIcon 5. GameThumbnail 6. GamePass 7. Asset 8. BundleThumbnail 9. Outfit 10. GroupIcon 11. DeveloperProduct 12. AutoGeneratedAsset 13. AvatarBust 14. PlaceIcon 15. AutoGeneratedGameIcon 16. ForceAutoGeneratedGameIcon 17. Look 18. CreatorContextAsset 19. Screenshot
{
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Roblox.Thumbnails.Apis.Models.ThumbnailBatchRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Roblox.Thumbnails.Apis.Models.ThumbnailBatchRequest"
}
}
}
},
"description": "List of ThumbnailBatchRequest objects, may contain the following request types:\n 1. Avatar\n 2. AvatarHeadShot\n 3. GameIcon\n 4. BadgeIcon\n 5. GameThumbnail\n 6. GamePass\n 7. Asset\n 8. BundleThumbnail\n 9. Outfit\n 10. GroupIcon\n 11. DeveloperProduct\n 12. AutoGeneratedAsset\n 13. AvatarBust\n 14. PlaceIcon\n 15. AutoGeneratedGameIcon\n 16. ForceAutoGeneratedGameIcon\n 17. Look\n 18. CreatorContextAsset\n 19. Screenshot",
"required": true
}Responses
| Status | Description |
|---|---|
| 200 | OK |
| 400 | 1: There are too many requested Ids. 2: The requested image format is invalid. Please see documentation for valid thumbnail format parameter name and values. 3: The requested size is invalid. Please see documentation for valid thumbnail size parameter name and format. 4: The requested Ids are invalid, of an invalid type or missing. 7: The specified type is not supported by the batch endpoint |
| 403 | 9: User not authorized to use AutoGenerated or ForceAutoGenerated return policies. |
{
"200": {
"description": "OK"
},
"400": {
"description": "1: There are too many requested Ids.\r\n2: The requested image format is invalid. Please see documentation for valid thumbnail format parameter name and values.\r\n3: The requested size is invalid. Please see documentation for valid thumbnail size parameter name and format.\r\n4: The requested Ids are invalid, of an invalid type or missing.\r\n7: The specified type is not supported by the batch endpoint"
},
"403": {
"description": "9: User not authorized to use AutoGenerated or ForceAutoGenerated return policies."
}
}Authentication
{
"security": [
{},
{
"roblox-legacy-cookie": []
}
],
"securitySchemes": {
"roblox-api-key": {
"type": "apiKey",
"description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
"name": "x-api-key",
"in": "header"
},
"roblox-legacy-cookie": {
"type": "apiKey",
"description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
"in": "cookie",
"name": ".ROBLOSECURITY"
},
"roblox-oauth2": {
"type": "oauth2",
"description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
"tokenUrl": "https://apis.roblox.com/oauth/v1/token",
"refreshUrl": "https://apis.roblox.com/oauth/v1/token",
"scopes": {}
}
}
}
}
}Related Schemas
Complete Operation Definition
{
"tags": [
"Thumbnails"
],
"summary": "Returns a list of thumbnails with varying types and sizes",
"parameters": [
{
"in": "header",
"name": "Roblox-Place-Id",
"description": "(optional) placeid",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Roblox.Thumbnails.Apis.Models.ThumbnailBatchRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Roblox.Thumbnails.Apis.Models.ThumbnailBatchRequest"
}
}
}
},
"description": "List of ThumbnailBatchRequest objects, may contain the following request types:\n 1. Avatar\n 2. AvatarHeadShot\n 3. GameIcon\n 4. BadgeIcon\n 5. GameThumbnail\n 6. GamePass\n 7. Asset\n 8. BundleThumbnail\n 9. Outfit\n 10. GroupIcon\n 11. DeveloperProduct\n 12. AutoGeneratedAsset\n 13. AvatarBust\n 14. PlaceIcon\n 15. AutoGeneratedGameIcon\n 16. ForceAutoGeneratedGameIcon\n 17. Look\n 18. CreatorContextAsset\n 19. Screenshot",
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "1: There are too many requested Ids.\r\n2: The requested image format is invalid. Please see documentation for valid thumbnail format parameter name and values.\r\n3: The requested size is invalid. Please see documentation for valid thumbnail size parameter name and format.\r\n4: The requested Ids are invalid, of an invalid type or missing.\r\n7: The specified type is not supported by the batch endpoint"
},
"403": {
"description": "9: User not authorized to use AutoGenerated or ForceAutoGenerated return policies."
}
},
"servers": [
{
"url": "https://thumbnails.roblox.com"
}
],
"x-roblox-stability": "STABLE",
"x-roblox-engine-usability": {
"apiKeyWithHttpService": false
},
"security": [
{},
{
"roblox-legacy-cookie": []
}
],
"externalDocs": {
"url": "https://create.roblox.com/docs/cloud/reference/features/thumbnails#thumbnails_post_v1_batch"
}
}