ROroblox
Avatars
Thumbnails
Users

Generate User Thumbnail

Changed on

Generates and returns the URL for the user's avatar thumbnail.

This is a long-running operation: the response is an Operation object. Poll the operation using its returned path until done is true. A completed operation contains either response or error:

  • If response is set, response.imageUri contains the thumbnail URL.
  • If error is set, the thumbnail couldn't be generated and response is not set. error.code and error.message describe the reason.

Always check for error before reading response.imageUri. See Get User Thumbnail Generation Operation.

get/cloud/v2/users/{user_id}:generateThumbnail

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/cloud/v2/users/{user_id}:generateThumbnail
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token

Path parameters

user_idstring required

The user ID.

Query parameters

sizeinteger

Size of the generated thumbnail. The generated thumbnail will have size * size dimension.

Currently supported values: 48, 50, 60, 75, 100, 110, 150, 180, 352, 420, 720 Default is 420.

format'FORMAT_UNSPECIFIED' | 'PNG' | 'JPEG'

Define the format of the thumbnail.

Specify the format of the generated thumbnail. Default is PNG.

Possible values:

ValueDescription
FORMAT_UNSPECIFIEDDefault UserThumbnail Format -- set to png
PNGGenerate thumbnail in .png format
JPEGGenerate thumbnail in .jpg format
shape'SHAPE_UNSPECIFIED' | 'ROUND' | 'SQUARE'

Define the shape of the thumbnail.

Specify the shape of the thumbnail. Default is ROUND (circular).

Possible values:

ValueDescription
SHAPE_UNSPECIFIEDDefault UserThumbnail Shape -- set to round
ROUNDGenerate thumbnail as a circle.
SQUAREGenerate thumbnail as a rectangle.

Response

OK

pathstring nullable

The server-assigned path, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the path should be a resource path ending with operations/{unique_id}.

metadataGenerateUserThumbnailMetadata

Represents metadata about the long-running operation corresponding to a GenerateUserThumbnail request.

This is the type of the Operation.metadata field in the response to GetOperation requests for GenerateUserThumbnail operations.

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

Changes

  • ce82f06a4ba6Revision changes
    • breaking

      for the query request parameter format, default value FORMAT_UNSPECIFIED was added

    • breaking

      for the query request parameter shape, default value SHAPE_UNSPECIFIED was added

    • breaking

      for the query request parameter size, default value 0 was added

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      for the query request parameter format, the format was generalized from enum to no format

    • info

      for the query request parameter shape, the format was generalized from enum to no format

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status