ROroblox
Avatars
Thumbnails
Users

Get User Thumbnail Generation Operation

Changed on

Gets the status and result of a Generate User Thumbnail long-running operation.

Call this with the operation path returned by Generate User Thumbnail, polling until done is true. Once complete, the operation contains either response or error:

  • If response is set, response.imageUri contains the generated 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.

get/cloud/v2/users/{user_id}/operations/{operation_id}

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/cloud/v2/users/{user_id}/operations/{operation_id}
  • 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.

operation_idstring required

The operation ID returned by Generate User Thumbnail.

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

  • 7c6787738100Revision changes
    • info

      api tag Avatars added

    • info

      api tag Thumbnails added

  • ce82f06a4ba6Revision changes
    • 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

      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