GET /v1/users/avatar-headshot — openapi

Get Avatar Headshots for the given CSV of userIds

Endpoint

Method: GET

Path: /v1/users/avatar-headshot

Servers:

https://thumbnails.roblox.com

Parameters

Name	Location	Required	Description
userIds	query	true	CSV for the userIds to get avatar headshots
includeBackground	query	false	Whether to include a background in the thumbnail (defaults to false)
includeProfileFrame	query	false	Whether to composite the user's equipped profile frame into the thumbnail (defaults to false)
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": "userIds",
    "description": "CSV for the userIds to get avatar headshots",
    "required": true,
    "style": "form",
    "explode": false,
    "schema": {
      "type": "array",
      "items": {
        "format": "int64",
        "type": "integer"
      }
    }
  },
  {
    "in": "query",
    "name": "includeBackground",
    "description": "Whether to include a background in the thumbnail (defaults to false)",
    "schema": {
      "type": "boolean",
      "default": false
    }
  },
  {
    "in": "query",
    "name": "includeProfileFrame",
    "description": "Whether to composite the user's equipped profile frame into the thumbnail (defaults to false)",
    "schema": {
      "type": "boolean",
      "default": false
    }
  },
  {
    "in": "query",
    "name": "size",
    "description": "The thumbnail size, formatted widthxheight",
    "schema": {
      "type": "string",
      "enum": [
        "48x48",
        "50x50",
        "60x60",
        "75x75",
        "100x100",
        "110x110",
        "150x150",
        "180x180",
        "352x352",
        "420x420",
        "720x720"
      ],
      "default": "48x48"
    }
  },
  {
    "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	1: There are too many requested Ids. 2: The requested image format is invalid. Please see documentation for valid thumbnail format parameter name and values. 3: The requested size is invalid. Please see documentation for valid thumbnail size parameter name and format. 4: The requested Ids are invalid, of an invalid type or missing. 10: Circular thumbnail requests are not allowed

{
  "200": {
    "description": "OK"
  },
  "400": {
    "description": "1: There are too many requested Ids.\r\n2: The requested image format is invalid. Please see documentation for valid thumbnail format parameter name and values.\r\n3: The requested size is invalid. Please see documentation for valid thumbnail size parameter name and format.\r\n4: The requested Ids are invalid, of an invalid type or missing.\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": [
    "Avatars",
    "Thumbnails"
  ],
  "summary": "Get Avatar Headshots for the given CSV of userIds",
  "parameters": [
    {
      "in": "query",
      "name": "userIds",
      "description": "CSV for the userIds to get avatar headshots",
      "required": true,
      "style": "form",
      "explode": false,
      "schema": {
        "type": "array",
        "items": {
          "format": "int64",
          "type": "integer"
        }
      }
    },
    {
      "in": "query",
      "name": "includeBackground",
      "description": "Whether to include a background in the thumbnail (defaults to false)",
      "schema": {
        "type": "boolean",
        "default": false
      }
    },
    {
      "in": "query",
      "name": "includeProfileFrame",
      "description": "Whether to composite the user's equipped profile frame into the thumbnail (defaults to false)",
      "schema": {
        "type": "boolean",
        "default": false
      }
    },
    {
      "in": "query",
      "name": "size",
      "description": "The thumbnail size, formatted widthxheight",
      "schema": {
        "type": "string",
        "enum": [
          "48x48",
          "50x50",
          "60x60",
          "75x75",
          "100x100",
          "110x110",
          "150x150",
          "180x180",
          "352x352",
          "420x420",
          "720x720"
        ],
        "default": "48x48"
      }
    },
    {
      "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": "1: There are too many requested Ids.\r\n2: The requested image format is invalid. Please see documentation for valid thumbnail format parameter name and values.\r\n3: The requested size is invalid. Please see documentation for valid thumbnail size parameter name and format.\r\n4: The requested Ids are invalid, of an invalid type or missing.\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/avatars#thumbnails_get_v1_users_avatar_headshot"
  }
}