AssetService
A non-replicated service that handles asset-related queries to the Roblox web API.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
| Memory category | Instances |
|---|
Member index 24
Removed member index 13
| History | Member | |
|---|---|---|
| 601 | CreateDynamicImageAsync(textureId: Content): DynamicImage | |
| 602 | CreateDynamicMeshAsync(meshId: Content): DynamicMesh | |
| 558 | GetAssetThumbnailAsync(assetId: int64, thumbnailSize: Vector2, assetType: int = 0): Tuple | |
| 319 | GetAssetVersions(placeId: int, pageNum: int = 1): Dictionary | |
| 319 | GetPlacePermissions(placeId: int): Dictionary | |
| 591 | LoadImageAsync(textureId: Content): DynamicImage | |
| 587 | PromptPublishAssetAsync(player: Player, instance: Instance, assetType: AssetType): Tuple | |
| 319 | RevertAsset(placeId: int, versionNumber: int): bool | |
| 310 | SetAssetRevertUrl(revertUrl: string): void | |
| 310 | SetAssetVersionsUrl(versionsUrl: string): void | |
| 310 | SetPlaceAccessUrl(accessUrl: string): void | |
| 319 | SetPlacePermissions(placeId: int, accessType: AccessType = Everyone, inviteList: Array = {}): bool | |
| 602 | createDynamicMeshFromPartAsync(meshPart: Instance): DynamicMesh |
Description
AssetService is a non-replicated service that handles asset-related queries to the Roblox web API.
History 73
- 619 Add CreateMeshPartAsync
- 614 Add AudioMetadataResponse
- 614 Add AudioMetadataRequest
- 614 Add AudioMetadataFailedResponse
- 610 Add GetAudioMetadataAsync
- 607 Add CreateEditableMeshStripSkinningAsync
- 602 Remove createDynamicMeshFromPartAsync
- 602 Add CreateEditableMeshFromPartAsync
- 602 Add CreateEditableMeshAsync
- 602 Remove CreateDynamicMeshAsync
- 601 Add createDynamicMeshFromPartAsync
- 601 Add CreateEditableImageAsync
- 601 Remove CreateDynamicImageAsync
- 594 Add PromptImportAnimationClipFromVideoAsync
- 593 Add CreateDynamicMeshAsync
- 591 Remove LoadImageAsync
- 591 Add CreateDynamicImageAsync
- 589 Add RegisterUGCValidationFunction
- 587 Add OpenCreateResultModal
- 587 Remove PromptPublishAssetAsync
- 587 Add PromptCreateAssetAsync
- 583 Add LoadImageAsync
- 583 Add DeserializeInstance
- 573 Change ReturnType of SavePlaceAsync from void to null
- 568 Add SearchAudio
- 567 Add OpenPublishResultModal
- 567 Add PromptPublishAssetAsync
- 558 Remove GetAssetThumbnailAsync
- 553 Change PreferredDescriptor of GetCreatorAssetID from to GetProductInfo
- 462 Change ThreadSafety of SavePlaceAsync from to Unsafe
- 462 Change ThreadSafety of GetGamePlacesAsync from to Unsafe
- 462 Change ThreadSafety of GetCreatorAssetID from to Unsafe
- 462 Change ThreadSafety of GetBundleDetailsSync from to Unsafe
- 462 Change ThreadSafety of GetBundleDetailsAsync from to Unsafe
- 462 Change ThreadSafety of GetAssetThumbnailAsync from to Unsafe
- 462 Change ThreadSafety of GetAssetIdsForPackage from to Unsafe
- 462 Change ThreadSafety of CreatePlaceInPlayerInventoryAsync from to Unsafe
- 462 Change ThreadSafety of CreatePlaceAsync from to Unsafe
- 375 Add GetBundleDetailsSync
- 360 Add GetBundleDetailsAsync
- 325 Change ReturnType of GetCreatorAssetID from int to int64
- 325 Change ReturnType of CreatePlaceInPlayerInventoryAsync from int to int64
- 325 Change ReturnType of CreatePlaceAsync from int to int64
- 319 Remove SetPlacePermissions
- 319 Remove RevertAsset
- 319 Remove GetPlacePermissions
- 319 Change Parameters of GetCreatorAssetID from (creationID: int) to (creationID: int64)
- 319 Remove GetAssetVersions
- 315 Change Parameters of GetAssetThumbnailAsync from (assetId: int, thumbnailSize: Vector2, assetType: int = 0) to (assetId: int64, thumbnailSize: Vector2, assetType: int = 0)
- 315 Change Parameters of GetAssetIdsForPackage from (packageAssetId: int) to (packageAssetId: int64)
- 315 Change Parameters of CreatePlaceInPlayerInventoryAsync from (player: Instance, placeName: string, templatePlaceID: int, description: string = ) to (player: Instance, placeName: string, templatePlaceID: int64, description: string = )
- 315 Change Parameters of CreatePlaceAsync from (placeName: string, templatePlaceID: int, description: string = ) to (placeName: string, templatePlaceID: int64, description: string = )
- 312 Add GetAssetThumbnailAsync
- 311 Remove GetAssetThumbnailAsync
- 312 Add GetAssetThumbnailAsync
- 310 Remove SetPlaceAccessUrl
- 310 Remove SetAssetVersionsUrl
- 310 Remove SetAssetRevertUrl
- 292 Change Tags of GetCreatorAssetID from [Yields] to [Yields, Deprecated]
- 268 Add GetAssetIdsForPackage
- 163 Add GetGamePlacesAsync
- 138 Add SavePlaceAsync
- 138 Add CreatePlaceInPlayerInventoryAsync
- 138 Add CreatePlaceAsync
- 122 Add GetCreatorAssetID
- 119 Add SetPlacePermissions
- 119 Add SetPlaceAccessUrl
- 119 Add SetAssetVersionsUrl
- 119 Add SetAssetRevertUrl
- 119 Add RevertAsset
- 119 Add GetPlacePermissions
- 119 Add GetAssetVersions
- 119 Add AssetService
Members 24
AudioMetadataFailedResponse
| Parameters (1) | |
|---|---|
| requestid | int64 |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
AudioMetadataRequest
| Parameters (2) | |
|---|---|
| requestid | int64 |
| request | Array |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
AudioMetadataResponse
| Parameters (2) | |
|---|---|
| requestid | int64 |
| response | Array |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
CreateEditableImageAsync
| Parameters (1) | ||
|---|---|---|
| textureId | Content | |
| Returns (1) | ||
| EditableImage | ||
Creates a new EditableImage instance populated with the given
texture. Non-asset texture IDs such as rbxthumb:// are supported. If
using an image asset, it must be associated with and/or owned by a creator
of the experience, or it must have been created inside the experience.
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
CreateEditableMeshAsync
| Parameters (1) | ||
|---|---|---|
| meshId | Content | |
| Returns (1) | ||
| EditableMesh | ||
Returns a new EditableMesh instance created from an existing mesh content ID.
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
CreateEditableMeshFromPartAsync
| Parameters (1) | ||
|---|---|---|
| meshPart | Instance | |
| Returns (1) | ||
| EditableMesh | ||
Returns a new EditableMesh instance created from the MeshId of an existing MeshPart.
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
CreateEditableMeshStripSkinningAsync
| Parameters (1) | ||
|---|---|---|
| meshId | Content | |
| Returns (1) | ||
| EditableMesh | ||
This function yields. It will block the calling thread until completion.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
CreateMeshPartAsync
| Parameters (2) | Default | |
|---|---|---|
| meshId | Content | |
| options | Dictionary | nil |
| Returns (1) | ||
| MeshPart | ||
This method creates a MeshPart with a specified CollisionFidelity, RenderFidelity, and FluidFidelity. Because MeshPart.MeshId is read only, this method is for creating a mesh with any mesh ID through scripts, without having to clone an existing MeshPart. It throws errors if creation fails.
This function yields. It will block the calling thread until completion.
| Security | PluginSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
CreatePlaceAsync
| Parameters (3) | Default | |
|---|---|---|
| placeName | string | |
| templatePlaceID | int64 | |
| description | string | |
| Returns (1) | ||
| int64 | ||
Clones a place through the given templatePlaceID and returns the
PlaceId of the new place, which you can use with
TeleportService. The clone place displays within the inventory of
the place's creator with the given name and description.
Note that the template place must have template copying enabled through place settings. You cannot use this method to clone places that you don't own.
Frequent use of this API is not recommended, particularly if the created places contain scripts, as updating the code in a large volume of places quickly becomes infeasible. For user-generated worlds, consider serializing user creations and saving them in DataStores instead.
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 4
- 462 Change ThreadSafety of CreatePlaceAsync from to Unsafe
- 325 Change ReturnType of CreatePlaceAsync from int to int64
- 315 Change Parameters of CreatePlaceAsync from (placeName: string, templatePlaceID: int, description: string = ) to (placeName: string, templatePlaceID: int64, description: string = )
- 138 Add CreatePlaceAsync
CreatePlaceInPlayerInventoryAsync
| Parameters (4) | Default | |
|---|---|---|
| player | Instance | |
| placeName | string | |
| templatePlaceID | int64 | |
| description | string | |
| Returns (1) | ||
| int64 | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 4
- 462 Change ThreadSafety of CreatePlaceInPlayerInventoryAsync from to Unsafe
- 325 Change ReturnType of CreatePlaceInPlayerInventoryAsync from int to int64
- 315 Change Parameters of CreatePlaceInPlayerInventoryAsync from (player: Instance, placeName: string, templatePlaceID: int, description: string = ) to (player: Instance, placeName: string, templatePlaceID: int64, description: string = )
- 138 Add CreatePlaceInPlayerInventoryAsync
DeserializeInstance
| Parameters (1) | ||
|---|---|---|
| serializedInstance | string | |
| Returns (1) | ||
| Instance | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
GetAssetIdsForPackage
| Parameters (1) | ||
|---|---|---|
| packageAssetId | int64 | |
| Returns (1) | ||
| Array | ||
Returns an array of asset IDs that are contained in a specified package.
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 3
- 462 Change ThreadSafety of GetAssetIdsForPackage from to Unsafe
- 315 Change Parameters of GetAssetIdsForPackage from (packageAssetId: int) to (packageAssetId: int64)
- 268 Add GetAssetIdsForPackage
GetAudioMetadataAsync
| Parameters (1) | ||
|---|---|---|
| idList | Array | |
| Returns (1) | ||
| Array | ||
Provides relevant metadata about a specific audio source (artist, title, duration, type, etc.).
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
GetBundleDetailsAsync
| Parameters (1) | ||
|---|---|---|
| bundleId | int64 | |
| Returns (1) | ||
| Dictionary | ||
This function returns details of the contents of the specified bundle.
If the bundle ID does not exist, it throws HTTP 400 (Bad Request). If
bundleId is not convertible to an integer, it throws
Unable to cast string to int64.
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetBundleDetailsAsync from to Unsafe
- 360 Add GetBundleDetailsAsync
GetBundleDetailsSync
| Parameters (1) | ||
|---|---|---|
| bundleId | int64 | |
| Returns (1) | ||
| Dictionary | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetBundleDetailsSync from to Unsafe
- 375 Add GetBundleDetailsSync
GetCreatorAssetID
| Parameters (1) | ||
|---|---|---|
| creationID | int64 | |
| Returns (1) | ||
| int64 | ||
The GetCreatorAssetID function returns the Player.UserId of the account who created the creationID asset.
This member is broken and doesn't function correctly. Avoid using it.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. GetProductInfo should be used instead.
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 6
- 553 Change PreferredDescriptor of GetCreatorAssetID from to GetProductInfo
- 462 Change ThreadSafety of GetCreatorAssetID from to Unsafe
- 325 Change ReturnType of GetCreatorAssetID from int to int64
- 319 Change Parameters of GetCreatorAssetID from (creationID: int) to (creationID: int64)
- 292 Change Tags of GetCreatorAssetID from [Yields] to [Yields, Deprecated]
- 122 Add GetCreatorAssetID
GetGamePlacesAsync
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Instance | ||
Returns a StandardPages object which contains the name and PlaceId of places within the current experience.
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetGamePlacesAsync from to Unsafe
- 163 Add GetGamePlacesAsync
OpenCreateResultModal
| Parameters (1) | |
|---|---|
| resultType | PromptCreateAssetResult |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
OpenPublishResultModal
| Parameters (1) | |
|---|---|
| resultType | PromptPublishAssetResult |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
PromptCreateAssetAsync
| Parameters (3) | ||
|---|---|---|
| player | Player | |
| instance | Instance | |
| assetType | AssetType | |
| Returns (1) | ||
| Tuple | ||
Allows in-experience asset creation for users by prompting a publish dialog. When called, it presents a dialog to the user, allowing them to enter a name, description, and preview the asset. Upon submitting, it saves the asset to the user's inventory. Can only be invoked on the server side.
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
PromptImportAnimationClipFromVideoAsync
| Parameters (2) | ||
|---|---|---|
| player | Player | |
| progressCallback | Function | |
| Returns (1) | ||
| Tuple | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
RegisterUGCValidationFunction
| Parameters (1) | ||
|---|---|---|
| function | Function | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
SavePlaceAsync
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
Saves the state of the current place. Only works for places that are created with AssetService:CreatePlaceAsync() or which have the API enabled through place settings.
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of SavePlaceAsync from void to null
- 462 Change ThreadSafety of SavePlaceAsync from to Unsafe
- 138 Add SavePlaceAsync
SearchAudio
| Parameters (1) | ||
|---|---|---|
| searchParameters | AudioSearchParams | |
| Returns (1) | ||
| AudioPages | ||
Returns a AudioPages object containing the result of the given search. Will not return fields with empty values.
Note that this method has a low HTTP request limit and can throw an error,
so it should always be wrapped in pcall() for error handling. Possible
error messages include:
| Error Message | Reason |
|---|---|
| HTTP 429 (Too Many Requests) | AssetService:SearchAudio() has been called too many times. |
| Unexpected type for data, expected array got null | The keyword argument was filtered. |
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
- 568 Add SearchAudio
Removed members 13
CreateDynamicImageAsync
| Parameters (1) | ||
|---|---|---|
| textureId | Content | |
| Returns (1) | ||
| DynamicImage | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 2
- 601 Remove CreateDynamicImageAsync
- 591 Add CreateDynamicImageAsync
CreateDynamicMeshAsync
| Parameters (1) | ||
|---|---|---|
| meshId | Content | |
| Returns (1) | ||
| DynamicMesh | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 2
- 602 Remove CreateDynamicMeshAsync
- 593 Add CreateDynamicMeshAsync
GetAssetThumbnailAsync
| Parameters (3) | Default | |
|---|---|---|
| assetId | int64 | |
| thumbnailSize | Vector2 | |
| assetType | int | 0 |
| Returns (1) | ||
| Tuple | ||
This function yields. It will block the calling thread until completion.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 6
- 558 Remove GetAssetThumbnailAsync
- 462 Change ThreadSafety of GetAssetThumbnailAsync from to Unsafe
- 315 Change Parameters of GetAssetThumbnailAsync from (assetId: int, thumbnailSize: Vector2, assetType: int = 0) to (assetId: int64, thumbnailSize: Vector2, assetType: int = 0)
- 312 Add GetAssetThumbnailAsync
- 311 Remove GetAssetThumbnailAsync
- 312 Add GetAssetThumbnailAsync
GetAssetVersions
| Parameters (2) | Default | |
|---|---|---|
| placeId | int | |
| pageNum | int | 1 |
| Returns (1) | ||
| Dictionary | ||
This function yields. It will block the calling thread until completion.
History 2
- 319 Remove GetAssetVersions
- 119 Add GetAssetVersions
GetPlacePermissions
| Parameters (1) | ||
|---|---|---|
| placeId | int | |
| Returns (1) | ||
| Dictionary | ||
This function yields. It will block the calling thread until completion.
History 2
- 319 Remove GetPlacePermissions
- 119 Add GetPlacePermissions
LoadImageAsync
| Parameters (1) | ||
|---|---|---|
| textureId | Content | |
| Returns (1) | ||
| DynamicImage | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 2
- 591 Remove LoadImageAsync
- 583 Add LoadImageAsync
PromptPublishAssetAsync
| Parameters (3) | ||
|---|---|---|
| player | Player | |
| instance | Instance | |
| assetType | AssetType | |
| Returns (1) | ||
| Tuple | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 2
- 587 Remove PromptPublishAssetAsync
- 567 Add PromptPublishAssetAsync
RevertAsset
| Parameters (2) | ||
|---|---|---|
| placeId | int | |
| versionNumber | int | |
| Returns (1) | ||
| bool | ||
This function yields. It will block the calling thread until completion.
History 2
- 319 Remove RevertAsset
- 119 Add RevertAsset
SetAssetRevertUrl
| Parameters (1) | ||
|---|---|---|
| revertUrl | string | |
| Returns (1) | ||
| void | ||
| Security | LocalUserSecurity |
|---|
History 2
- 310 Remove SetAssetRevertUrl
- 119 Add SetAssetRevertUrl
SetAssetVersionsUrl
| Parameters (1) | ||
|---|---|---|
| versionsUrl | string | |
| Returns (1) | ||
| void | ||
| Security | LocalUserSecurity |
|---|
History 2
- 310 Remove SetAssetVersionsUrl
- 119 Add SetAssetVersionsUrl
SetPlaceAccessUrl
| Parameters (1) | ||
|---|---|---|
| accessUrl | string | |
| Returns (1) | ||
| void | ||
| Security | LocalUserSecurity |
|---|
History 2
- 310 Remove SetPlaceAccessUrl
- 119 Add SetPlaceAccessUrl
SetPlacePermissions
| Parameters (3) | Default | |
|---|---|---|
| placeId | int | |
| accessType | AccessType | Everyone |
| inviteList | Array | {} |
| Returns (1) | ||
| bool | ||
This function yields. It will block the calling thread until completion.
History 2
- 319 Remove SetPlacePermissions
- 119 Add SetPlacePermissions
createDynamicMeshFromPartAsync
| Parameters (1) | ||
|---|---|---|
| meshPart | Instance | |
| Returns (1) | ||
| DynamicMesh | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|