GET /cloud/v2/users/{user_id}/operations/{operation_id} — openapi

Get User Thumbnail Generation Operation

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.

Endpoint

Method: GET

Path: /cloud/v2/users/{user_id}/operations/{operation_id}

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
user_id	path	true	The user ID.
operation_id	path	true	The operation ID returned by Generate User Thumbnail.

[
  {
    "name": "user_id",
    "in": "path",
    "description": "The user ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "operation_id",
    "in": "path",
    "description": "The operation ID returned by Generate User Thumbnail.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	Success

{
  "200": {
    "description": "Success",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OpenCloudUsers.Operation"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": []
    }
  ],
  "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": {}
        }
      }
    }
  }
}

OpenCloudUsers.Operation

Complete Operation Definition

{
  "tags": [
    "Avatars",
    "Thumbnails",
    "Users"
  ],
  "summary": "Get User Thumbnail Generation Operation",
  "description": "Gets the status and result of a\r\n[Generate User Thumbnail](https://create.roblox.com/docs/cloud/reference/features/users#Cloud_GenerateUserThumbnail)\r\nlong-running operation.\r\n            \r\nCall this with the operation `path` returned by Generate User Thumbnail,\r\npolling until `done` is `true`. Once complete, the operation contains\r\neither `response` or `error`:\r\n            \r\n- If `response` is set, `response.imageUri` contains the generated\r\n  thumbnail URL.\r\n- If `error` is set, the thumbnail couldn't be generated and `response` is\r\n  not set. `error.code` and `error.message` describe the reason.\r\n            \r\nAlways check for `error` before reading `response.imageUri`.",
  "operationId": "Cloud_GetUserThumbnailGenerationOperation",
  "parameters": [
    {
      "name": "user_id",
      "in": "path",
      "description": "The user ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "operation_id",
      "in": "path",
      "description": "The operation ID returned by Generate User Thumbnail.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OpenCloudUsers.Operation"
          }
        }
      }
    }
  },
  "x-roblox-stability": "STABLE",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 1000
    },
    "perOauth2Authorization": {
      "period": "MINUTE",
      "maxInPeriod": 10
    }
  },
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": true
  },
  "security": [
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/avatars#Cloud_GetUserThumbnailGenerationOperation"
  }
}