GET /v1/asset — openapi

Endpoint

Method: GET

Path: /v1/asset

Servers:

https://assetdelivery.roblox.com

Parameters

Name	Location	Required
Accept-Encoding	header	true
Roblox-Place-Id	header	true
AssetType	header	true
AssetFormat	header	true
Roblox-AssetFormat	header	true
Roblox-Usage-Context	header	false
id	query	false
userAssetId	query	false
assetVersionId	query	false
version	query	false
universeId	query	false
clientInsert	query	false
scriptinsert	query	false
modulePlaceId	query	false
serverplaceid	query	false
assetName	query	false
hash	query	false
marAssetHash	query	false
marCheckSum	query	false
expectedAssetType	query	false
skipSigningScripts	query	false
permissionContext	query	false
doNotFallbackToBaselineRepresentation	query	false
contentRepresentationPriorityList	query	false
assetResolutionMode	query	false
accessContext	query	false

[
  {
    "in": "header",
    "name": "Accept-Encoding",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "header",
    "name": "Roblox-Place-Id",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "header",
    "name": "AssetType",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "header",
    "name": "AssetFormat",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "header",
    "name": "Roblox-AssetFormat",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "header",
    "name": "Roblox-Usage-Context",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "id",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "userAssetId",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "assetVersionId",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "version",
    "schema": {
      "type": "integer",
      "format": "int32"
    }
  },
  {
    "in": "query",
    "name": "universeId",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "clientInsert",
    "schema": {
      "type": "integer",
      "format": "int32"
    }
  },
  {
    "in": "query",
    "name": "scriptinsert",
    "schema": {
      "type": "integer",
      "format": "int32"
    }
  },
  {
    "in": "query",
    "name": "modulePlaceId",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "serverplaceid",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "assetName",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "hash",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "marAssetHash",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "marCheckSum",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "expectedAssetType",
    "schema": {
      "type": "string",
      "default": ""
    }
  },
  {
    "in": "query",
    "name": "skipSigningScripts",
    "schema": {
      "type": "boolean",
      "default": false
    }
  },
  {
    "in": "query",
    "name": "permissionContext",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "doNotFallbackToBaselineRepresentation",
    "schema": {
      "type": "boolean"
    }
  },
  {
    "in": "query",
    "name": "contentRepresentationPriorityList",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "assetResolutionMode",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "accessContext",
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK"
  }
}

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": [
    "Assets"
  ],
  "parameters": [
    {
      "in": "header",
      "name": "Accept-Encoding",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "header",
      "name": "Roblox-Place-Id",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "header",
      "name": "AssetType",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "header",
      "name": "AssetFormat",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "header",
      "name": "Roblox-AssetFormat",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "header",
      "name": "Roblox-Usage-Context",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "id",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "userAssetId",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "assetVersionId",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "version",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "in": "query",
      "name": "universeId",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "clientInsert",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "in": "query",
      "name": "scriptinsert",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "in": "query",
      "name": "modulePlaceId",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "serverplaceid",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "assetName",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "hash",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "marAssetHash",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "marCheckSum",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "expectedAssetType",
      "schema": {
        "type": "string",
        "default": ""
      }
    },
    {
      "in": "query",
      "name": "skipSigningScripts",
      "schema": {
        "type": "boolean",
        "default": false
      }
    },
    {
      "in": "query",
      "name": "permissionContext",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "doNotFallbackToBaselineRepresentation",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "in": "query",
      "name": "contentRepresentationPriorityList",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "assetResolutionMode",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "accessContext",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK"
    }
  },
  "servers": [
    {
      "url": "https://assetdelivery.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/assets#assetdelivery_get_v1_asset"
  },
  "x-roblox-recommended-alternatives": [
    {
      "url": "https://assetdelivery.roblox.com/v2/asset",
      "httpMethod": "GET",
      "documentationUrl": "https://create.roblox.com/docs/cloud/reference/features/assets#assetdelivery_get_v2_asset"
    }
  ]
}