Asset Delivery v2

Reference for the Asset Delivery v2 endpoints on Roblox.

Base URL: https://assetdelivery.roblox.com

Endpoints

Method	Path	Name
GET	/v2/alias/:alias	getAliasAlias
GET	/v2/asset	getAsset
GET	/v2/assetId/:assetId	getAssetidAssetid
GET	/v2/assetId/:assetId/version/:versionNumber	getAssetidAssetidVersionVersionnumber
POST	/v2/assets/batch	postAssetsBatch
GET	/v2/marAssetHash/:marAssetHash/marCheckSum/:marCheckSum	getMarassethashMarassethashMarchecksumMarchecksum

getAliasAlias

GET /v2/alias/:alias

Usage

import { fetchApi } from 'rozod';
import { getAliasAlias } from 'rozod/endpoints/assetdeliveryv2';

const data = await fetchApi(getAliasAlias, {
  alias: /* string */,
  AssetType: /* string */,
  AssetFormat: /* string */,
  skipSigningScripts: /* boolean? */,
  clientInsert: /* integer? */,
  scriptinsert: /* integer? */,
  modulePlaceId: /* integer? */,
  serverplaceid: /* integer? */,
  expectedAssetType: /* string? */,
  accessContext: /* string? */
});

Parameters

Name	Type	Required	Description
alias	string	Yes
AssetType	string	Yes
AssetFormat	string	Yes
skipSigningScripts	boolean?	No
clientInsert	integer?	No
scriptinsert	integer?	No
modulePlaceId	integer?	No
serverplaceid	integer?	No
expectedAssetType	string?	No
accessContext	string?	No

Response

Field	Type	Description
locations	object[]	See below
errors	object[]	See below
requestId	string
isArchived	boolean
assetTypeId	number
contentRepresentationSpecifier	object	See below
isRecordable	boolean

locations[] item fields:

Field	Type	Description
assetFormat	string
location	string
assetMetadatas	object[]	See below

assetMetadatas[] item fields:

Field	Type	Description
metadataType	'UncompressedSize'
value	string

errors[] item fields:

Field	Type	Description
Code	number
Message	string
CustomErrorCode	`“UnknownError”	“NoPermissionToAsset”

contentRepresentationSpecifier fields:

Field	Type	Description
format	string
majorVersion	string
fidelity	string
skipGenerationIfNotExist	boolean

---

getAsset

GET /v2/asset

Usage

import { fetchApi } from 'rozod';
import { getAsset } from 'rozod/endpoints/assetdeliveryv2';

const data = await fetchApi(getAsset, {
  AssetType: /* string */,
  AssetFormat: /* string */,
  id: /* integer? */,
  userAssetId: /* integer? */,
  assetVersionId: /* integer? */,
  version: /* integer? */,
  universeId: /* integer? */,
  clientInsert: /* integer? */,
  scriptinsert: /* integer? */,
  modulePlaceId: /* integer? */,
  serverplaceid: /* string? */,
  assetName: /* string? */,
  hash: /* string? */,
  marAssetHash: /* string? */,
  marCheckSum: /* string? */,
  expectedAssetType: /* string? */,
  skipSigningScripts: /* boolean? */,
  permissionContext: /* string? */,
  doNotFallbackToBaselineRepresentation: /* boolean? */,
  contentRepresentationPriorityList: /* string? */,
  accessContext: /* string? */
});

Parameters

Name	Type	Required	Description
AssetType	string	Yes
AssetFormat	string	Yes
id	integer?	No
userAssetId	integer?	No
assetVersionId	integer?	No
version	integer?	No
universeId	integer?	No
clientInsert	integer?	No
scriptinsert	integer?	No
modulePlaceId	integer?	No
serverplaceid	string?	No
assetName	string?	No
hash	string?	No
marAssetHash	string?	No
marCheckSum	string?	No
expectedAssetType	string?	No
skipSigningScripts	boolean?	No
permissionContext	string?	No
doNotFallbackToBaselineRepresentation	boolean?	No
contentRepresentationPriorityList	string?	No
accessContext	string?	No

Response

Field	Type	Description
locations	object[]	See below
errors	object[]	See below
requestId	string
isArchived	boolean
assetTypeId	number
contentRepresentationSpecifier	object	See below
isRecordable	boolean

locations[] item fields:

Field	Type	Description
assetFormat	string
location	string
assetMetadatas	object[]	See below

assetMetadatas[] item fields:

Field	Type	Description
metadataType	'UncompressedSize'
value	string

errors[] item fields:

Field	Type	Description
Code	number
Message	string
CustomErrorCode	`“UnknownError”	“NoPermissionToAsset”

contentRepresentationSpecifier fields:

Field	Type	Description
format	string
majorVersion	string
fidelity	string
skipGenerationIfNotExist	boolean

---

getAssetidAssetid

GET /v2/assetId/:assetId

Usage

import { fetchApi } from 'rozod';
import { getAssetidAssetid } from 'rozod/endpoints/assetdeliveryv2';

const data = await fetchApi(getAssetidAssetid, {
  assetId: /* integer */,
  AssetType: /* string */,
  AssetFormat: /* string */,
  skipSigningScripts: /* boolean? */,
  clientInsert: /* integer? */,
  scriptinsert: /* integer? */,
  modulePlaceId: /* integer? */,
  serverplaceid: /* integer? */,
  expectedAssetType: /* string? */,
  doNotFallbackToBaselineRepresentation: /* boolean? */,
  contentRepresentationPriorityList: /* string? */,
  accessContext: /* string? */
});

Parameters

Name	Type	Required	Description
assetId	integer	Yes
AssetType	string	Yes
AssetFormat	string	Yes
skipSigningScripts	boolean?	No
clientInsert	integer?	No
scriptinsert	integer?	No
modulePlaceId	integer?	No
serverplaceid	integer?	No
expectedAssetType	string?	No
doNotFallbackToBaselineRepresentation	boolean?	No
contentRepresentationPriorityList	string?	No
accessContext	string?	No

Response

Field	Type	Description
locations	object[]	See below
errors	object[]	See below
requestId	string
isArchived	boolean
assetTypeId	number
contentRepresentationSpecifier	object	See below
isRecordable	boolean

locations[] item fields:

Field	Type	Description
assetFormat	string
location	string
assetMetadatas	object[]	See below

assetMetadatas[] item fields:

Field	Type	Description
metadataType	'UncompressedSize'
value	string

errors[] item fields:

Field	Type	Description
Code	number
Message	string
CustomErrorCode	`“UnknownError”	“NoPermissionToAsset”

contentRepresentationSpecifier fields:

Field	Type	Description
format	string
majorVersion	string
fidelity	string
skipGenerationIfNotExist	boolean

---

getAssetidAssetidVersionVersionnumber

GET /v2/assetId/:assetId/version/:versionNumber

Usage

import { fetchApi } from 'rozod';
import { getAssetidAssetidVersionVersionnumber } from 'rozod/endpoints/assetdeliveryv2';

const data = await fetchApi(getAssetidAssetidVersionVersionnumber, {
  assetId: /* integer */,
  versionNumber: /* integer */,
  AssetType: /* string */,
  AssetFormat: /* string */,
  skipSigningScripts: /* boolean? */,
  clientInsert: /* integer? */,
  scriptinsert: /* integer? */,
  modulePlaceId: /* integer? */,
  serverplaceid: /* integer? */,
  expectedAssetType: /* string? */,
  doNotFallbackToBaselineRepresentation: /* boolean? */,
  contentRepresentationPriorityList: /* string? */,
  accessContext: /* string? */
});

Parameters

Name	Type	Required	Description
assetId	integer	Yes
versionNumber	integer	Yes
AssetType	string	Yes
AssetFormat	string	Yes
skipSigningScripts	boolean?	No
clientInsert	integer?	No
scriptinsert	integer?	No
modulePlaceId	integer?	No
serverplaceid	integer?	No
expectedAssetType	string?	No
doNotFallbackToBaselineRepresentation	boolean?	No
contentRepresentationPriorityList	string?	No
accessContext	string?	No

Response

Field	Type	Description
locations	object[]	See below
errors	object[]	See below
requestId	string
isArchived	boolean
assetTypeId	number
contentRepresentationSpecifier	object	See below
isRecordable	boolean

locations[] item fields:

Field	Type	Description
assetFormat	string
location	string
assetMetadatas	object[]	See below

assetMetadatas[] item fields:

Field	Type	Description
metadataType	'UncompressedSize'
value	string

errors[] item fields:

Field	Type	Description
Code	number
Message	string
CustomErrorCode	`“UnknownError”	“NoPermissionToAsset”

contentRepresentationSpecifier fields:

Field	Type	Description
format	string
majorVersion	string
fidelity	string
skipGenerationIfNotExist	boolean

---

postAssetsBatch

POST /v2/assets/batch

Usage

import { fetchApi } from 'rozod';
import { postAssetsBatch } from 'rozod/endpoints/assetdeliveryv2';

const data = await fetchApi(postAssetsBatch, {
  body: { /* ... */ }
});

Request Body

Array of objects:

Field	Type	Description
assetName	string
assetType	string
clientInsert	boolean
placeId	number
requestId	string
scriptInsert	boolean
serverPlaceId	number
universeId	number
accept	string
encoding	string
hash	string
userAssetId	number
assetId	number
version	number
assetVersionId	number
modulePlaceId	number
assetFormat	string
assetResolutionMode	string
accessContext	string
usageContext	string
contentRepresentationPriorityList	string
doNotFallbackToBaselineRepresentation	boolean
xcachesplit	number

Response

Array of objects:

Field	Type	Description
locations	object[]	See below
errors	object[]	See below
requestId	string
isArchived	boolean
assetTypeId	number
contentRepresentationSpecifier	object	See below
isRecordable	boolean

locations[] item fields:

Field	Type	Description
assetFormat	string
location	string
assetMetadatas	object[]	See below

assetMetadatas[] item fields:

Field	Type	Description
metadataType	'UncompressedSize'
value	string

errors[] item fields:

Field	Type	Description
Code	number
Message	string
CustomErrorCode	`“UnknownError”	“NoPermissionToAsset”

contentRepresentationSpecifier fields:

Field	Type	Description
format	string
majorVersion	string
fidelity	string
skipGenerationIfNotExist	boolean

---

getMarassethashMarassethashMarchecksumMarchecksum

GET /v2/marAssetHash/:marAssetHash/marCheckSum/:marCheckSum

Usage

import { fetchApi } from 'rozod';
import { getMarassethashMarassethashMarchecksumMarchecksum } from 'rozod/endpoints/assetdeliveryv2';

const data = await fetchApi(getMarassethashMarassethashMarchecksumMarchecksum, {
  marAssetHash: /* string */,
  marCheckSum: /* string */,
  AssetType: /* string */,
  AssetFormat: /* string */,
  skipSigningScripts: /* boolean? */,
  clientInsert: /* integer? */,
  scriptinsert: /* integer? */,
  modulePlaceId: /* integer? */,
  serverplaceid: /* integer? */,
  expectedAssetType: /* string? */
});

Parameters

Name	Type	Required	Description
marAssetHash	string	Yes
marCheckSum	string	Yes
AssetType	string	Yes
AssetFormat	string	Yes
skipSigningScripts	boolean?	No
clientInsert	integer?	No
scriptinsert	integer?	No
modulePlaceId	integer?	No
serverplaceid	integer?	No
expectedAssetType	string?	No

Response

Field	Type	Description
locations	object[]	See below
errors	object[]	See below
requestId	string
isArchived	boolean
assetTypeId	number
contentRepresentationSpecifier	object	See below
isRecordable	boolean

locations[] item fields:

Field	Type	Description
assetFormat	string
location	string
assetMetadatas	object[]	See below

assetMetadatas[] item fields:

Field	Type	Description
metadataType	'UncompressedSize'
value	string

errors[] item fields:

Field	Type	Description
Code	number
Message	string
CustomErrorCode	`“UnknownError”	“NoPermissionToAsset”

contentRepresentationSpecifier fields:

Field	Type	Description
format	string
majorVersion	string
fidelity	string
skipGenerationIfNotExist	boolean

---