GET /v1/games/multiget/thumbnails — openapi

Fetch game thumbnail URLs for a list of universe IDs.

Endpoint

Method: GET

Path: /v1/games/multiget/thumbnails

Servers:

https://thumbnails.roblox.com

Parameters

Name	Location	Required	Description
universeIds	query	true	comma-delimited list of universe IDs
countPerUniverse	query	false	max number of thumbnails to return per universe
defaults	query	false	true if defaults (if any) should be returned if no media exists
size	query	false	The thumbnail size, formatted widthxheight
format	query	false	The thumbnail format
isCircular	query	false	The circle thumbnail output parameter, true or false

[
  {
    "in": "query",
    "name": "universeIds",
    "description": "comma-delimited list of universe IDs",
    "required": true,
    "style": "form",
    "explode": false,
    "schema": {
      "type": "array",
      "items": {
        "format": "int64",
        "type": "integer"
      }
    }
  },
  {
    "in": "query",
    "name": "countPerUniverse",
    "description": "max number of thumbnails to return per universe",
    "schema": {
      "type": "integer",
      "format": "int32",
      "default": 1
    }
  },
  {
    "in": "query",
    "name": "defaults",
    "description": "true if defaults (if any) should be returned if no media exists",
    "schema": {
      "type": "boolean",
      "default": true
    }
  },
  {
    "in": "query",
    "name": "size",
    "description": "The thumbnail size, formatted widthxheight",
    "schema": {
      "type": "string",
      "enum": [
        "768x432",
        "576x324",
        "480x270",
        "384x216",
        "256x144"
      ],
      "default": "768x432"
    }
  },
  {
    "in": "query",
    "name": "format",
    "description": "The thumbnail format",
    "schema": {
      "type": "string",
      "enum": [
        "Png",
        "Jpeg",
        "Webp"
      ],
      "default": "Png"
    }
  },
  {
    "in": "query",
    "name": "isCircular",
    "description": "The circle thumbnail output parameter, true or false",
    "schema": {
      "type": "boolean",
      "enum": [
        "true",
        "false"
      ],
      "default": "false"
    }
  }
]

Responses

Status	Description
200	OK
400	0: Unknown error 1: There are too many requested Ids. 4: The requested Ids are invalid, of an invalid type or missing. 5: The requested universe does not exist. 10: Circular thumbnail requests are not allowed

{
  "200": {
    "description": "OK"
  },
  "400": {
    "description": "0: Unknown error\r\n1: There are too many requested Ids.\r\n4: The requested Ids are invalid, of an invalid type or missing.\r\n5: The requested universe does not exist.\r\n10: Circular thumbnail requests are not allowed"
  }
}

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": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Thumbnails",
    "Universes"
  ],
  "summary": "Fetch game thumbnail URLs for a list of universe IDs.",
  "parameters": [
    {
      "in": "query",
      "name": "universeIds",
      "description": "comma-delimited list of universe IDs",
      "required": true,
      "style": "form",
      "explode": false,
      "schema": {
        "type": "array",
        "items": {
          "format": "int64",
          "type": "integer"
        }
      }
    },
    {
      "in": "query",
      "name": "countPerUniverse",
      "description": "max number of thumbnails to return per universe",
      "schema": {
        "type": "integer",
        "format": "int32",
        "default": 1
      }
    },
    {
      "in": "query",
      "name": "defaults",
      "description": "true if defaults (if any) should be returned if no media exists",
      "schema": {
        "type": "boolean",
        "default": true
      }
    },
    {
      "in": "query",
      "name": "size",
      "description": "The thumbnail size, formatted widthxheight",
      "schema": {
        "type": "string",
        "enum": [
          "768x432",
          "576x324",
          "480x270",
          "384x216",
          "256x144"
        ],
        "default": "768x432"
      }
    },
    {
      "in": "query",
      "name": "format",
      "description": "The thumbnail format",
      "schema": {
        "type": "string",
        "enum": [
          "Png",
          "Jpeg",
          "Webp"
        ],
        "default": "Png"
      }
    },
    {
      "in": "query",
      "name": "isCircular",
      "description": "The circle thumbnail output parameter, true or false",
      "schema": {
        "type": "boolean",
        "enum": [
          "true",
          "false"
        ],
        "default": "false"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK"
    },
    "400": {
      "description": "0: Unknown error\r\n1: There are too many requested Ids.\r\n4: The requested Ids are invalid, of an invalid type or missing.\r\n5: The requested universe does not exist.\r\n10: Circular thumbnail requests are not allowed"
    }
  },
  "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_get_v1_games_multiget_thumbnails"
  }
}