3 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GET /v1/assets/{assetId} — assets/v1

Retrieve specific asset metadata. Include the readMask parameter for additional asset metadata.

Retrieve specific asset metadata.

Endpoint

Method: GET

Path: /v1/assets/{assetId}

Servers:

• https://apis.roblox.com/assets

Parameters

[
  {
    "name": "assetId",
    "in": "path",
    "description": "The unique identifier of the asset.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "readMask",
    "in": "query",
    "description": "Asset metadata fields to retrieve, including the description, display name, icon, social links, and previews. Examples: `description%2CdisplayName`, `previews%2CtwitchSocialLink`.",
    "schema": {
      "type": "string"
    }
  }
]

Responses

{
  "200": {
    "description": "Asset resource retrieved successfully.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Asset"
        }
      }
    }
  },
  "400": {
    "description": "Malformed request, likely due to an invalid read mask."
  },
  "401": {
    "description": "The API key is not valid for this operation / You don't have the authorization."
  },
  "403": {
    "description": "Doesn't have the required permission."
  },
  "404": {
    "description": "Asset doesn't exist."
  },
  "500": {
    "description": "Server internal error / Unknown error."
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": [
        "asset:read"
      ]
    },
    {
      "roblox-oauth2": [
        "asset: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.",
      "in": "header",
      "name": "x-api-key"
    },
    "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": {
            "asset:read": "This allows viewing information about your assets.",
            "asset:write": "This allows uploading and updating assets to Roblox."
          }
        }
      }
    }
  }
}

Related Schemas

• Asset

Complete Operation Definition

{
  "tags": [
    "Assets"
  ],
  "x-roblox-cloud-api-operation": true,
  "x-roblox-cloud-api-operation-name": "Get Asset",
  "x-roblox-stability": "BETA",
  "summary": "Retrieve specific asset metadata. Include the `readMask` parameter for additional asset metadata.",
  "description": "Retrieve specific asset metadata.",
  "operationId": "Assets_GetAsset",
  "parameters": [
    {
      "name": "assetId",
      "in": "path",
      "description": "The unique identifier of the asset.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "readMask",
      "in": "query",
      "description": "Asset metadata fields to retrieve, including the description, display name, icon, social links, and previews. Examples: `description%2CdisplayName`, `previews%2CtwitchSocialLink`.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Asset resource retrieved successfully.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Asset"
          }
        }
      }
    },
    "400": {
      "description": "Malformed request, likely due to an invalid read mask."
    },
    "401": {
      "description": "The API key is not valid for this operation / You don't have the authorization."
    },
    "403": {
      "description": "Doesn't have the required permission."
    },
    "404": {
      "description": "Asset doesn't exist."
    },
    "500": {
      "description": "Server internal error / Unknown error."
    }
  },
  "security": [
    {
      "roblox-api-key": [
        "asset:read"
      ]
    },
    {
      "roblox-oauth2": [
        "asset:read"
      ]
    }
  ],
  "x-roblox-scopes": [
    {
      "name": "asset:read"
    }
  ],
  "x-roblox-cloud-api-operation-code-samples": [
    {
      "language": "Get Asset without readMask",
      "script": "curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \\\n--header 'x-api-key: {apiKey}'"
    },
    {
      "language": "Get Asset with readMask",
      "script": "curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \\\n--header 'x-api-key: {apiKey}'"
    }
  ]
}