GET /v1/users/avatar-3d — openapi

Get Avatar 3d object for a user

Endpoint

Method: GET

Path: /v1/users/avatar-3d

Servers:

https://thumbnails.roblox.com

Parameters

Name	Location	Required	Description
userId	query	true	user Id for avatar

[
  {
    "in": "query",
    "name": "userId",
    "description": "user Id for avatar",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Responses

Status	Description
200	OK
400	4: The requested Ids are invalid, of an invalid type or missing.

{
  "200": {
    "description": "OK"
  },
  "400": {
    "description": "4: The requested Ids are invalid, of an invalid type or missing."
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": [
        "thumbnail:read"
      ]
    }
  ],
  "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": [
    "Avatars",
    "Thumbnails"
  ],
  "summary": "Get Avatar 3d object for a user",
  "parameters": [
    {
      "in": "query",
      "name": "userId",
      "description": "user Id for avatar",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK"
    },
    "400": {
      "description": "4: The requested Ids are invalid, of an invalid type or missing."
    }
  },
  "servers": [
    {
      "url": "https://thumbnails.roblox.com"
    }
  ],
  "x-roblox-stability": "BETA",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 500
    },
    "perOauth2Authorization": {
      "period": "MINUTE",
      "maxInPeriod": 500
    }
  },
  "x-roblox-scopes": [
    {
      "name": "thumbnail:read",
      "targetResourceSpecifier": ""
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": [
        "thumbnail:read"
      ]
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/avatars#thumbnails_get_v1_users_avatar_3d"
  }
}