Skip to content

InsertService

Supported Class Services NotCreatable Service

Used to insert assets from the Roblox website.

26 Nova members · 8 modern Roblox members not implemented yet

Description

InsertService is used to insert assets from the Roblox website, typically the LoadAsset function.

To load an asset, it must be accessible by the creator of the experience loading it, which can be either a user or group. Should an experience be uploaded by a different creator, the asset data would not be accessible. See the LoadAsset() method for more details on this security check. Note that you should not use this service for loading API keys or other secrets. Use HttpService.GetSecret() instead.

See Also

  • AssetService, which can provide information about assets you might want to load using InsertService

Inheritance

Object → Instance → InsertService

Nova inheritance: Instance → InsertService

Properties

AllowInsertFreeModels Supported Property Deprecated Indicates whether ''Free Models'' can be inserted into the game. 
AllowInsertFreeModels: bool

Indicates whether ''Free Models'' can be inserted into the game.

The AllowInsertFreeModels property toggles whether ''Free Models'' can be inserted into the game, regardless of whether the place owner owns the asset.

Roblox documentation

Methods

ApproveAssetId Supported Function Deprecated Nova: no-op Legacy approval call. Accepted for compatibility; does nothing. 
InsertService:ApproveAssetId(int assetId)

Legacy approval call. Accepted for compatibility; does nothing.

The Nova implementation is an empty function. Scripts that call it will not error, but no approval occurs.

Roblox reference signature 
InsertService:ApproveAssetId(assetId: int64): null
Nova behaviour: Nova keeps this legacy member for compatibility. Roblox's modern deprecation wording may describe later Roblox behaviour; verify it against Nova before relying on the copied text.

Roblox documentation

ApproveAssetVersionId Supported Function Deprecated Nova: no-op Legacy approval call. Accepted for compatibility; does nothing. 
InsertService:ApproveAssetVersionId(int assetVersionId)

Legacy approval call. Accepted for compatibility; does nothing.

The Nova implementation is an empty function. Scripts that call it will not error, but no approval occurs.

Roblox reference signature 
InsertService:ApproveAssetVersionId(assetVersionId: int64): null
Nova behaviour: Nova keeps this legacy member for compatibility. Roblox's modern deprecation wording may describe later Roblox behaviour; verify it against Nova before relying on the copied text.

Roblox documentation

GetBaseCategories Supported Function Deprecated Deprecated. Use GetBaseSets() instead. 
InsertService:GetBaseCategories(): Array

Deprecated. Use GetBaseSets() instead.

Nova behaviour: Nova keeps this legacy member for compatibility. Roblox's modern deprecation wording may describe later Roblox behaviour; verify it against Nova before relying on the copied text.

Roblox documentation

GetBaseSets Supported Function Deprecated Returns an array of dictionaries, containing information about various Roblox approved sets. 
InsertService:GetBaseSets(): Array

Returns an array of dictionaries, containing information about various Roblox approved sets.

Roblox documentation

GetCollection Supported Function Deprecated Returns the most recently uploaded models in the specified category. 
InsertService:GetCollection(int categoryId): Array

Returns the most recently uploaded models in the specified category.

Roblox reference signature 
InsertService:GetCollection(categoryId: int64): Array

Roblox documentation

GetFreeDecals Supported Function Deprecated Retrieves a list of free Decals from the Catalog. 
InsertService:GetFreeDecals(string searchText, int pageNum): Array

Retrieves a list of free Decals from the Catalog.

Roblox reference signature 
InsertService:GetFreeDecals(searchText: string, pageNum: int): Array

Roblox documentation

GetFreeModels Supported Function Deprecated Retrieves a list of Free Models from the Catalog. 
InsertService:GetFreeModels(string searchText, int pageNum): Array

Retrieves a list of Free Models from the Catalog.

Roblox reference signature 
InsertService:GetFreeModels(searchText: string, pageNum: int): Array

Roblox documentation

GetLatestAssetVersionAsync Supported Function Returns the latest AssetVersionId of an asset for assets created by the place creator. Can be used in combination with InsertService.LoadAssetVersion… 
InsertService:GetLatestAssetVersionAsync(int assetId): int

Returns the latest AssetVersionId of an asset for assets created by the place creator. Can be used in combination with InsertService.LoadAssetVersion() to load the latest version of a model, even if it gets updated while the game is running.

Roblox reference signature 
InsertService:GetLatestAssetVersionAsync(assetId: int64): int64

Roblox documentation

GetUserCategories Supported Function Deprecated Deprecated. Use GetUserSets() instead. 
InsertService:GetUserCategories(int userId): Array

Deprecated. Use GetUserSets() instead.

Roblox reference signature 
InsertService:GetUserCategories(userId: User): Array
Nova behaviour: Nova keeps this legacy member for compatibility. Roblox's modern deprecation wording may describe later Roblox behaviour; verify it against Nova before relying on the copied text.

Roblox documentation

GetUserSets Supported Function Deprecated Returns an array of dictionaries, containing information about sets owned by the user. 
InsertService:GetUserSets(int userId): Array

Returns an array of dictionaries, containing information about sets owned by the user. This includes

  • Sets the user is subscribed to.
  • Sets that the user created.
  • A single set containing the models created by the user.
  • A single set containing the decals created by the user.

Note:

  • All values in the dictionaries are strings, even if they are a number.
Name Description
Name The name of the set.
Description The description of the set.
ImageAssetId An assetId for the icon of the set.
CreatorName The creator of the set.
AssetSetId The set's unique ID on the website.
CategoryId Identical to AssetSetId
SetType The type of set that this set is.
Roblox reference signature 
InsertService:GetUserSets(userId: User): Array

Roblox documentation

Insert Supported Function Deprecated Inserts Instance into Workspace. 
InsertService:Insert(Instance instance)

Inserts Instance into Workspace.

This function is a legacy method used to insert an Instance into Workspace.

Roblox reference signature 
InsertService:Insert(instance: Instance): null
Nova behaviour: Nova keeps this legacy member for compatibility. Roblox's modern deprecation wording may describe later Roblox behaviour; verify it against Nova before relying on the copied text.

Roblox documentation

LoadAsset Supported Function Returns a Model containing the asset. 
InsertService:LoadAsset(int assetId): Instance

The LoadAsset function fetches an asset given its ID and returns a Model containing the asset. For example, to load this public Doge Model, which has the asset ID 257489726, you can use:

local InsertService = game:GetService("InsertService")
local Workspace = game:GetService("Workspace")

local assetId = 257489726
local model = InsertService:LoadAsset(assetId)
model.Parent = Workspace

Calls to this function may fail if a server providing a model is having problems. As such, it's generally a good idea to wrap calls to this function in pcall to catch these kinds of errors.

local InsertService = game:GetService("InsertService")
local Workspace = game:GetService("Workspace")

local assetId = 257489726

local success, model = pcall(InsertService.LoadAsset, InsertService, assetId)
if success and model then
    print("Model loaded successfully")
    model.Parent = Workspace
else
    print("Model failed to load!")
end

Security Check

An asset loaded by this function must meet one of the following:

  • The asset must be created or owned by the game creator.
  • The asset must be shared by the asset owner.
  • The asset must be owned by Roblox.

Additionally, benign asset types such as t-shirts, shirts, pants and avatar accessories are loadable from any game as they are OpenUse.

To load assets which do not meet the above criteria, such as free Models published on the Store, you must use AssetService.LoadAssetAsync() and enable AssetService.AllowInsertFreeAssets.

See also:

Roblox reference signature 
InsertService:LoadAsset(assetId: int64): Instance

Roblox documentation

loadAsset Supported Function Deprecated 
InsertService:loadAsset(int assetId): Instance

No description available.

Roblox reference signature 
InsertService:loadAsset(assetId: int64): Instance
Nova behaviour: Nova keeps this legacy member for compatibility. Roblox's modern deprecation wording may describe later Roblox behaviour; verify it against Nova before relying on the copied text.

Roblox documentation

LoadAssetVersion Supported Function Returns a model inserted into InsertService containing the asset with the given assetVersionId. 
InsertService:LoadAssetVersion(int assetVersionId): Instance

Returns a model inserted into InsertService containing the asset with the given assetVersionId.

Roblox reference signature 
InsertService:LoadAssetVersion(assetVersionId: int64): Instance

Roblox documentation

SetAdvancedResults Supported Function 
InsertService:SetAdvancedResults(bool enable, bool user = false)

No description available.

Security: LocalUserSecurity

Roblox documentation

SetAssetUrl Supported Function 
InsertService:SetAssetUrl(string assetUrl)

No description available.

Security: LocalUserSecurity

Roblox documentation

SetAssetVersionUrl Supported Function 
InsertService:SetAssetVersionUrl(string assetVersionUrl)

No description available.

Security: LocalUserSecurity

Roblox documentation

SetBaseCategoryUrl Supported Function 
InsertService:SetBaseCategoryUrl(string baseSetsUrl)

No description available.

Security: LocalUserSecurity

Roblox documentation

SetBaseSetsUrl Supported Function 
InsertService:SetBaseSetsUrl(string baseSetsUrl)

No description available.

Security: LocalUserSecurity

Roblox documentation

SetCollectionUrl Supported Function 
InsertService:SetCollectionUrl(string collectionUrl)

No description available.

Security: LocalUserSecurity

Roblox documentation

SetFreeDecalUrl Supported Function 
InsertService:SetFreeDecalUrl(string freeDecalUrl)

No description available.

Security: LocalUserSecurity

Roblox documentation

SetFreeModelUrl Supported Function 
InsertService:SetFreeModelUrl(string freeModelUrl)

No description available.

Security: LocalUserSecurity

Roblox documentation

SetTrustLevel Supported Function 
InsertService:SetTrustLevel(float trustLevel)

No description available.

Security: LocalUserSecurity

Roblox documentation

SetUserCategoryUrl Supported Function 
InsertService:SetUserCategoryUrl(string userSetsUrl)

No description available.

Security: LocalUserSecurity

Roblox documentation

SetUserSetsUrl Supported Function 
InsertService:SetUserSetsUrl(string userSetsUrl)

No description available.

Security: LocalUserSecurity

Roblox documentation

Inherited members

Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.

8 modern Roblox member(s) are not implemented yet — expand to inspect

Members declared by Roblox's InsertService class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.

Methods

Member Signature Status Notes Flags
CreateMeshPartAsync InsertService:CreateMeshPartAsync(meshId: ContentId, collisionFidelity: CollisionFidelity, renderFidelity: RenderFidelity): MeshPart Not yet Creates a new MeshPart with specified fidelity values. Yields
GetFreeDecalsAsync InsertService:GetFreeDecalsAsync(searchText: string, pageNum: int): Array Not yet Retrieves a list of free Decals from the Catalog. Yields
GetFreeModelsAsync InsertService:GetFreeModelsAsync(searchText: string, pageNum: int): Array Not yet Retrieves a list of Free Models from the Catalog. Yields
GetLocalFileContents InsertService:GetLocalFileContents(contentId: string): string Not yet — RobloxScriptSecurity
LoadAssetWithBytecodeAsync InsertService:LoadAssetWithBytecodeAsync(content: Content): Instance Not yet — Yields, RobloxScriptSecurity
LoadAssetWithFormat InsertService:LoadAssetWithFormat(assetId: int64, format: string): Instances Not yet — Yields, RobloxScriptSecurity
LoadLocalAsset InsertService:LoadLocalAsset(assetPath: string): Instance Not yet — RobloxScriptSecurity
LoadPackageAssetAsync InsertService:LoadPackageAssetAsync(url: ContentId): Instances Not yet — Yields, RobloxScriptSecurity

Roblox reference: InsertService

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.