Learn
Engine Class
AvatarCreationService
Not Creatable
Service


API Reference
Methods
AutoSetupAvatarAsync
Yields
Capabilities: DynamicGeneration
AvatarCreationService:AutoSetupAvatarAsync(
player:Player, autoSetupParams:Dictionary, progressCallback:function?
Parameters
player:Player
autoSetupParams:Dictionary
progressCallback:function?
Returns
Code Samples
AutoSetupAvatarAsync
local AvatarCreationService = game:GetService("AvatarCreationService")
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local LoadAvatarEvent = ReplicatedStorage.LoadAvatarEvent
local generatedAvatars = {}
-- Must be called on the server
local function setupAvatar(player: Player, avatarModel: Model, layeredShirtModel : Model)
local arguments = {
Body = avatarModel,
Accessories = {}
}
local accessoryArgument = {
AccessoryType = Enum.AccessoryType.Shirt,
IsLayered = true,
Instance = layeredShirtModel,
}
table.insert(arguments.Accessories, accessoryArgument)
local pcallSuccess, result = pcall(function()
local generationId = AvatarCreationService:AutoSetupAvatarAsync(
player,
arguments,
function(progressInfo)
print(`AutoSetup progress: {progressInfo.Progress * 100}%`)
end
)
-- Load and store on the server to use with PromptCreateAvatarAsync
local humanoidDescription = AvatarCreationService:LoadGeneratedAvatarAsync(generationId)
generatedAvatars[generationId] = humanoidDescription
-- Signal the client so it can load the avatar for local preview
LoadAvatarEvent:FireClient(player, generationId)
end)
if not pcallSuccess then
warn("Avatar setup failed:", result)
end
end

GenerateAvatar2DPreviewAsync
Yields
Capabilities: DynamicGeneration
AvatarCreationService:GenerateAvatar2DPreviewAsync(
avatarGeneration2dPreviewParams:Dictionary, progressCallback:function?
Parameters
avatarGeneration2dPreviewParams:Dictionary
progressCallback:function?
Returns

GenerateAvatarAsync
Yields
Capabilities: DynamicGeneration
AvatarCreationService:GenerateAvatarAsync(
avatarGenerationParams:Dictionary, progressCallback:function?
Parameters
avatarGenerationParams:Dictionary
progressCallback:function?
Returns

GetBatchTokenDetailsAsync
Yields
Capabilities: Monetization
AvatarCreationService:GetBatchTokenDetailsAsync(tokenIds:{any}):{any}
Parameters
tokenIds:{any}
Returns

GetValidationRules
AvatarCreationService:GetValidationRules():Dictionary
Returns

LoadAvatar2DPreviewAsync
Yields
Capabilities: DynamicGeneration
AvatarCreationService:LoadAvatar2DPreviewAsync(previewId:string):EditableImage
Parameters
previewId:string

LoadGeneratedAvatarAsync
Yields
Capabilities: DynamicGeneration
AvatarCreationService:LoadGeneratedAvatarAsync(generationId:string):HumanoidDescription
Parameters
generationId:string
Code Samples
LoadGeneratedAvatarAsync
local AvatarCreationService = game:GetService("AvatarCreationService")
local Players = game:GetService("Players")
-- Can be called on either the server or client
local function loadAvatar(generationId: string): Model?
local pcallSuccess, result = pcall(function()
local humanoidDescription = AvatarCreationService:LoadGeneratedAvatarAsync(generationId)
local model = Players:CreateHumanoidModelFromDescriptionAsync(humanoidDescription, Enum.HumanoidRigType.R15)
return model
end)
if pcallSuccess then
return result
else
print("Avatar failed to load:", result)
return nil
end
end

PrepareAvatarForPreviewAsync
Yields
Capabilities: AvatarAppearance
AvatarCreationService:PrepareAvatarForPreviewAsync(humanoidModel:Model):()
Parameters
humanoidModel:Model
Returns
()

PromptCreateAvatarAssetAsync
Yields
AvatarCreationService:PromptCreateAvatarAssetAsync(
tokenId:string, player:Player, assetInstance:Instance, assetType:Enum.AvatarAssetType
Parameters
tokenId:string
player:Player
assetInstance:Instance
Returns
Code Samples
PromptCreateAvatarAssetAsync
local AvatarCreationService = game:GetService("AvatarCreationService")
local function publishAvatarAsset(tokenId: string, player: Player, assetInstance: Accessory, assetType: Enum.AvatarAssetType)
local pcallSuccess, result, resultMessage = pcall(function()
return AvatarCreationService:PromptCreateAvatarAssetAsync(tokenId, player, assetInstance, assetType)
end)
if pcallSuccess then
if result == Enum.PromptCreateAssetResult.Success then
print("Successfully uploaded with AssetId: ", resultMessage)
else
print("Unsuccessfully uploaded with error message:", resultMessage)
end
else
print("Avatar asset failed to create.")
end
end

PromptCreateAvatarAsync
Yields
Capabilities: AssetCreateUpdate, Monetization
AvatarCreationService:PromptCreateAvatarAsync(
tokenId:string, player:Player, humanoidDescription:HumanoidDescription
Parameters
tokenId:string
player:Player
humanoidDescription:HumanoidDescription
Returns
Code Samples
PromptCreateAvatarAsync
local AvatarCreationService = game:GetService("AvatarCreationService")
export type BodyPartInfo = {
bodyPart: Enum.BodyPart,
instance: Instance, --Folder with Created MeshParts
}
export type BodyPartList = { BodyPartInfo }
local function publishAvatar(bodyPartInstances: BodyPartList, player: Player, tokenId: string)
local humanoidDescription = Instance.new("HumanoidDescription")
for _, bodyPartInfo in bodyPartInstances do
local bodyPartDescription = Instance.new("BodyPartDescription")
bodyPartDescription.Instance = bodyPartInfo.instance
bodyPartDescription.BodyPart = bodyPartInfo.bodyPart
bodyPartDescription.Parent = humanoidDescription
end
local pcallSuccess, result, resultMessage = pcall(function()
return AvatarCreationService:PromptCreateAvatarAsync(tokenId, player, humanoidDescription)
end)
if pcallSuccess then
if result == Enum.PromptCreateAvatarResult.Success then
print("Successfully uploaded with BundleId: ", resultMessage)
else
print("Unsuccessfully uploaded with error message:", resultMessage)
end
else
print("Avatar failed to create.")
end
end

PromptSelectAvatarGenerationImageAsync
Yields
Capabilities: SensitiveInput
AvatarCreationService:PromptSelectAvatarGenerationImageAsync(player:Player):string
Parameters
player:Player
Returns

RequestAvatarGenerationSessionAsync
Yields
Capabilities: DynamicGeneration
AvatarCreationService:RequestAvatarGenerationSessionAsync(
player:Player, callback:function
Parameters
player:Player
callback:function
Returns

ValidateUGCAccessoryAsync
Yields
AvatarCreationService:ValidateUGCAccessoryAsync(
player:Player, accessory:Instance, accessoryType:Enum.AccessoryType
Parameters
player:Player
accessory:Instance
accessoryType:Enum.AccessoryType
Returns

ValidateUGCBodyPartAsync
Yields
AvatarCreationService:ValidateUGCBodyPartAsync(
player:Player, instance:Instance, bodyPart:Enum.BodyPart
Parameters
player:Player
instance:Instance
bodyPart:Enum.BodyPart
Returns

ValidateUGCFullBodyAsync
Yields
AvatarCreationService:ValidateUGCFullBodyAsync(
player:Player, humanoidDescription:HumanoidDescription
Parameters
player:Player
humanoidDescription:HumanoidDescription
Returns

Events
AvatarAssetModerationCompleted
Capabilities: DynamicGeneration
AvatarCreationService.AvatarAssetModerationCompleted(
assetId:number, moderationStatus:Enum.ModerationStatus
Parameters
assetId:number
moderationStatus:Enum.ModerationStatus
Code Samples
Avatar Asset Moderation Completed
local AvatarCreationService = game:GetService("AvatarCreationService")
local conn = AvatarCreationService.AvatarAssetModerationCompleted:Connect(function(assetId, moderationStatus)
print("Asset, " .. assetId .. ", ready with moderation status: " .. moderationStatus)
end)

AvatarModerationCompleted
Capabilities: DynamicGeneration
AvatarCreationService.AvatarModerationCompleted(
outfitId:number, moderationStatus:Enum.ModerationStatus
Parameters
outfitId:number
moderationStatus:Enum.ModerationStatus

©2026 Roblox Corporation. Roblox, the Roblox logo and Powering Imagination are among our registered and unregistered trademarks in the U.S. and other countries.