Creator

Creators are a base class inherited by User and Group. This reference documents APIs related to assets and the creator store.

Creator store endpoints to search the toolbox and asset saving are in ApiKey instead.

`rblxopencloud.Asset`

Represents an asset uploaded by a Creator.

Attributes:

Name	Type	Description
`id`	`int`	The asset's ID.
`name`	`str`	The filtered name of the asset.
`description`	`str`	The filtered description of the asset.
`type`	`AssetType`	The asset's type.
`creator`	`Union[Creator, User, Group]`	The user, group, or creator which uploaded the asset.
`moderation_status`	`ModerationStatus`	The asset's current moderation status.
`revision_id`	`Optional[int]`	The ID of the current revision of the asset. Will be `None` if the asset type does not support updating.
`revision_time`	`Optional[datetime]`	The time the current revision of the asset was created. Will be `None` if the asset type does not support updating.
`is_archived`	`bool`	Whether the asset has been archived.
`icon_asset_id`	`Optional[int]`	The image asset ID of the asset's icon.
`preview_asset_ids`	`Optional[list[int]]`	A list of asset IDs for the asset's preview images and videos.
`facebook_social_link`	`AssetSocialLink`	The asset's Facebook social link.
`twitter_social_link`	`AssetSocialLink`	The asset's Twitter social link.
`youtube_social_link`	`AssetSocialLink`	The asset's YouTube social link.
`twitch_social_link`	`AssetSocialLink`	The asset's Twitch social link.
`discord_social_link`	`AssetSocialLink`	The asset's Discord social link.
`github_social_link`	`AssetSocialLink`	The asset's GitHub social link.
`roblox_social_link`	`AssetSocialLink`	The asset's Roblox social link.
`guilded_social_link`	`AssetSocialLink`	The asset's Guilded social link.
`devforum_social_link`	`AssetSocialLink`	The asset's DevForum social link.
`try_place_id`	`Optional[int]`	The place ID set for the asset's 'Try in Roblox' button.

`fetch_delivery_location`

Fetches the download location for this asset using Asset Delivery.

Requires the legacy-assets:manage API key permission.

Parameters:

Name	Type	Description	Default
`version_number`	`Optional[int]`	The version number of the asset to fetch the location for. If not provided, the latest version will be used.	`None`

Returns:

Type	Description
`AssetDeliveryLocation`	An `AssetDeliveryLocation` containing information on downloading the asset.

`fetch_creator_store_product`

Fetches the creator store product information for this asset, if it is on the creator store.

Returns:

Type	Description
`CreatorStoreProduct`	An `CreatorStoreProduct` representing the asset as a prodct.

`fetch_toolbox_asset`

Fetches the toolbox information about the asset. This will also update the current asset object with any information fetched, such as name, description, type, social links, and try place ID.

Requires creator-store-product:read on an API key. OAuth2 authorization is not supported. No authorization is supported (i.e. api_key is None).

Returns:

Type	Description
`ToolboxAsset`	The asset information for the toolbox asset.

`fetch_version`

Fetches a specific version of the asset.

Parameters:

Name	Type	Description	Default
`version_number`	`int`	The version number of the asset to fetch.	required

Returns:

Type	Description
`AssetVersion`	An `AssetVersion` representing the specified version of the asset.

`list_versions`

Iterates all avaliable versions of the asset, providing the latest version first.

Parameters:

Name	Type	Description	Default
`limit`	`int`	The maximum number of versions to return.	`None`

Yields:

Type	Description
`Iterable[AssetVersion]`	An asset version for each version of the asset.

`rollback`

Rolls back the asset to restore a previous version.

Parameters:

Name	Type	Description	Default
`version_number`	`int`	The version number of the asset to roll back to.	required

Returns:

Type	Description
`AssetVersion`	An `AssetVersion` representing the rolled back version of the asset.

`archive`

Archives the asset so it cannot be seen on the website or used in experiences.

Returns:

Type	Description
`Asset`	The updated asset information.

`restore`

Unarchives an archived asset.

Returns:

Type	Description
`Asset`	The updated asset information.

Creatable Dataclasses

`rblxopencloud.AssetPermissionRequest`

Data class representing an asset in a permission grant request.

Parameters:

Name	Type	Description	Default
`asset_id`	`int`	The ID of the asset being granted permissions.	required
`grant_dependencies`	`bool`	Whether to also grant permissions for the asset's dependencies.	`False`
`version_number`	`Optional[int]`	The version number of the asset to use when granting permission to dependencies.	`None`

`rblxopencloud.AssetPermissionSubject`

Represents a subject when granting permissions with grant_assets_permission. A subject can be a user, group, a group role, experience, or everyone on Roblox.

Where this class is used, a User, Group, GroupRole, or Experience object can also be used in its place.

Parameters:

Name	Type	Description	Default
`type`	`AssetPermissionSubjectType`	The type of subject.	required
`id`	`Optional[int]`	The ID of the subject. Not required when the type is `All`.	`None`

Attributes:

Name	Type	Description
`type`	`AssetPermissionSubjectType`	The type of subject.
`id`	`Optional[int]`	The ID of the subject. Will be `None` when the type is `All`.

`rblxopencloud.AssetSocialLink`

Represents a social link on an asset.

Parameters:

Name	Type	Description	Default
`title`	`Optional[str]`	The text displayed for the social link.	`None`
`uri`	`str`	The URI of the social link.	required

Attributes:

Name	Type	Description
`title`	`Optional[str]`	The text displayed for the social link.
`uri`	`str`	The URI of the social link.

`rblxopencloud.Money`

Represents a price on the Roblox platform, such as on the creator store.

Parameters:

Name	Type	Description	Default
`currency`	`str`	The ISO 4217 currency code for this price.	required
`quantity`	`float`	The quantity of the currency. For instance, `4.99` would be four dollars and ninety-nine cents in USD.	required

Attributes:

Name	Type	Description
`currency`	`str`	The ISO 4217 currency code for this price. Crypto and virtual currencies will begin with `X-`.
`quantity`	`float`	The quantity of the currency. For instance, `4.99` would be four dollars and ninety-nine cents in USD.

Supported Operations:

Operator	Description
`==`	Whether two `Money` have the same currency and quantity or `quantity` equals the `float`.
`<`	Whether the `quantity` is less than the `quantity` of another `Money` with the same currency or a `float`. Also supports `<=`.
`>`	Whether the `quantity` is greater than the `quantity` of another `Money` with the same currency or a `float`. Also supports `>=`.

`to_scientific_notation()`

Converts the quantity to a dict containing a significand and exponent used internally for Roblox's API.

Returns:

Type	Description
`dict`	A dictionary with `significand` and `exponent` values representing the quantity.

Non-creatable Dataclasses

`rblxopencloud.AssetDeliveryLocation`

Represents a location to download an asset from Roblox.

Attributes:

Name	Type	Description
`uri`	`str`	The URI to download the asset from.
`is_archived`	`bool`	Whether the asset has been archived.
`is_recordable`	`bool`	Whether the asset can be recorded in screen recordings.
`size_bytes`	`Optional[int]`	The size of the asset in bytes.

`download()`

Downloads the asset.

Returns:

Type	Description
`BytesIO`	A stream containing the asset file.

`rblxopencloud.AssetPermissionResult`

Represents the result of an asset permission grant request.

Attributes:

Name	Type	Description
`granted_asset_ids`	`list[int]`	A list of asset IDs for which permissions were successfully granted.
`failed_asset_ids`	`dict[int, AssetPermissionResultError]`	A mapping of asset IDs to their corresponding failure reasons for assets that failed to have permissions granted.

`rblxopencloud.AssetVersion`

Represents a version of an asset uploaded on to Roblox.

Attributes:

Name	Type	Description
`version_number`	`int`	This asset version's revision ID.
`asset_id`	`int`	The asset's ID.
`creator`	`Union[Creator, User, Group]`	The user, group, or creator which uploaded the asset.
`moderation_status`	`ModerationStatus`	The moderation status of this version.
`published`	`bool`	Whether this version is published, only applies to Places.

`rblxopencloud.Creator`

Represents an object that can upload assets, such as a user or a group.

Attributes:

Name	Type	Description
`id`	`int`	The ID of the creator.

`fetch_asset(asset_id)`

Fetches an asset uploaded to Roblox.

Parameters:

Name	Type	Description	Default
`asset_id`	`int`	The ID of the asset to fetch.	required

Returns:

Type	Description
`Asset`	An `Asset` representing the asset.

`upload_asset(file, asset_type, name, description, expected_robux_price=0, asset_privacy=AssetPrivacy.Default)`

Uploads the file to Roblox as an asset and returns an Operation. The following asset types are currently supported:

Asset Type	File Formats
Decal	`.png`, `.jpeg`, `.bmp`, `.tga`
Audio	`.mp3`, `.ogg`, `.wav`, `.flac`
Model	`.fbx`, `.gltf`, `.glb`, `.rbxm`, `.rbxmx`
Video	`.mp4`, `.mov`
Animation	`.rbxm`, `.rbxmx`

According to Roblox staff in this DevForum post, the maximum file size using the API is 30MB.

Parameters:

Name	Type	Description	Default
`file`	`BytesIO`	The file opened in bytes to be uploaded.	required
`asset_type`	`Union[AssetType, str]`	The `AssetType` for the asset type you're uploading.	required
`name`	`str`	The name of your asset.	required
`description`	`str`	The description of your asset.	required
`expected_robux_price`	`int`	The amount of robux expected to upload this asset. Will fail if lower than the actual price.	`0`
`asset_privacy`	`AssetPrivacy`	Whether the asset is restricted or open use.	`Default`

Returns:

Type	Description
`Operation[Asset]`	Returns a `Operation` for the asset upload operation where `T` is an `Asset`.

Danger

Avoid uploading assets to Roblox that you don't have full control over, such as AI generated assets or content created by unknown people. Assets uploaded that break Roblox's Terms of Services can get your account moderated.

For OAuth2 developers, it has been confirmed by Roblox staff in this DevForum post, that your app will not be punished if a malicious user uses it to upload Terms of Service violating content, and instead the authorizing user's account will be punished.

`update_asset(asset_id, file=None, name=None, description=None, expected_robux_price=0, facebook_social_link=None, twitter_social_link=None, youtube_social_link=None, twitch_social_link=None, discord_social_link=None, github_social_link=None, roblox_social_link=None, guilded_social_link=None, devforum_social_link=None, try_place_id=None)`

Updates an asset on Roblox with the provided file. The following asset types are currently supported for file uploading:

Asset Type	File Formats
Model	`.fbx`

Parameters:

Name	Type	Description	Default
`asset_id`	`int`	The ID of the asset to update.	required
`file`	`BytesIO`	The file opened in bytes to upload. The asset must be one of the supported file formats above.	`None`
`name`	`str`	The new name of the asset.	`None`
`description`	`str`	The new description for the asset.	`None`
`expected_robux_price`	`int`	The amount of robux expected to update this asset. Will fail if lower than the actual price.	`0`
`facebook_social_link`	`Optional[Union[AssetSocialLink, None]]`	The new Facebook social link for the asset, or `False` to remove the social link.	`None`
`twitter_social_link`	`Optional[Union[AssetSocialLink, None]]`	The new Twitter social link for the asset, or `False` to remove the social link.	`None`
`youtube_social_link`	`Optional[Union[AssetSocialLink, None]]`	The new YouTube social link for the asset, or `False` to remove the social link.	`None`
`twitch_social_link`	`Optional[Union[AssetSocialLink, None]]`	The new Twitch social link for the asset, or `False` to remove the social link.	`None`
`discord_social_link`	`Optional[Union[AssetSocialLink, None]]`	The new Discord social link for the asset, or `False` to remove the social link.	`None`
`github_social_link`	`Optional[Union[AssetSocialLink, None]]`	The new GitHub social link for the asset, or `False` to remove the social link.	`None`
`roblox_social_link`	`Optional[Union[AssetSocialLink, None]]`	The new Roblox social link for the asset, or `False` to remove the social link.	`None`
`guilded_social_link`	`Optional[Union[AssetSocialLink, None]]`	The new Guilded social link for the asset, or `False` to remove the social link.	`None`
`devforum_social_link`	`Optional[Union[AssetSocialLink, None]]`	The new DevForum social link for the asset, or `False` to remove the social link.	`None`
`try_place_id`	`Optional[Union[int, bool]]`	A place ID to set for the asset's 'Try in Roblox' button. Set to `False` to remove the Try in Roblox button.	`None`

Returns:

Type	Description
`Operation[Asset]`	Returns a `Operation` for the asset update operation where `T` is an `Asset`.

`list_asset_versions(asset_id, limit=None)`

Iterates all avaliable versions of the asset, providing the latest version first.

Parameters:

Name	Type	Description	Default
`asset_id`	`int`	The ID of the asset to find versions for.	required
`limit`	`int`	The maximum number of versions to return.	`None`

Yields:

Type	Description
`Iterable[AssetVersion]`	An asset version for each version of the asset.

`fetch_asset_version(asset_id, version_number)`

Fetches the version for a specific version number of the asset.

Parameters:

Name	Type	Description	Default
`asset_id`	`int`	The ID of the asset to find the version for.	required
`version_number`	`int`	The version number to find.	required

Returns:

Type	Description
`AssetVersion`	The found asset version.

`rollback_asset(asset_id, version_number)`

Reverts the asset to a previous version specified.

Parameters:

Name	Type	Description	Default
`asset_id`	`int`	The ID of the asset to rollback.	required
`version_number`	`int`	The version number to rollback to.	required

Returns:

Type	Description
`AssetVersion`	The new asset version.

`archive_asset(asset_id)`

Archives the asset so it cannot be seen on the website or used in experiences.

Parameters:

Name	Type	Description	Default
`asset_id`	`int`	The ID of the asset to archive.	required

Returns:

Type	Description
`Asset`	The updated asset information.

`restore_asset(asset_id)`

Unarchives an archived asset.

Parameters:

Name	Type	Description	Default
`asset_id`	`int`	The ID of the archived asset to unarchive.	required

Returns:

Type	Description
`Asset`	The updated asset information.

`fetch_asset_delivery_location(asset_id, version_number=None, expected_asset_type=None)`

Fetches the download location for this asset using Asset Delivery.

Requires the legacy-assets:manage API key permission.

Parameters:

Name	Type	Description	Default
`asset_id`	`int`	The ID of the asset to fetch the location for.	required
`version_number`	`Optional[int]`	The specific version number of the asset to fetch the location for. Defaults to the latest version.	`None`
`expected_asset_type`	`Optional[Union[AssetType, str]]`	The expected type of the asset. If provided, the request will fail if the asset is not of the provided type.	`None`

Returns:

Type	Description
`AssetDeliveryLocation`	An `AssetDeliveryLocation` containing information on downloading the asset.

`fetch_creator_store_product(asset_type, product_id)`

Fetches information about an asset on the creator store.

Parameters:

Name	Type	Description	Default
`asset_type`	`Union[AssetType, str]`	The type of asset the product is.	required
`product_id`	`int`	The ID of the asset to fetch.	required

Returns:

Type	Description
`CreatorStoreProduct`	A `CreatorStoreProduct` representing the asset.

Tip

If the asset type is unknown or other information such as the description is required, use the fetch_asset.

`fetch_toolbox_asset(asset_id)`

Fetches information about an asset in the toolbox.

Requires creator-store-product:read on an API key. OAuth2 authorization is not supported. No authorization is supported (i.e. api_key is None).

Parameters:

Name	Type	Description	Default
`asset_id`	`int`	The ID of the asset to fetch.	required

Returns:

Type	Description
`ToolboxAsset`	The asset information for the toolbox asset. The current creator object (e.g. user or group) will also be updated with resolved information such as name and verified status.

Tip

To search for assets in the toolbox, use ApiKey.search_toolbox.

`grant_assets_permission(action, subject, assets)`

Grants permission to the subject to perform the specified action on the provided assets. See the table in AssetPermissionAction for allowed actions per asset and subject type.

Parameters:

Name	Type	Description	Default
`action`	`AssetPermissionAction`	The action to grant permission for.	required
`subject`	`Union[AssetPermissionSubject, Experience, User, Group, GroupRole]`	The subject to grant the permission to.	required
`assets`	`list[Union[int, Asset, AssetPermissionRequest]]`	The asset IDs or assets to grant permission for. Use `AssetPermissionRequest` to specify additional options per asset.	required

Returns:

Type	Description
`AssetPermissionResult`	The results of each asset permission grant request. Do not expect the function to raise an exceptions for errors, instead check the `failed_asset_ids` attribute.

Warning

Once permission is granted to a subject, it cannot be revoked using the API. It may also not be able to be revoked using the website, depending on the asset type and subject type. For instance, granting Open Use to All on a decal sets it as Open Use which cannot be revoked; however, granting Download to All on a place can be revoked on the Creator Dashboard.

Example

Setting the root place of an experience to be uncopylocked.

from rblxopencloud import Experience, AssetPermissionAction,             AssetPermissionSubject, AssetPermissionSubjectType

experience = Experience(00000000, "...") # initialise with ID and API key
experience.fetch_info() # Fetch root place

# grant download permission to everyone on Roblox
experience.creator.grant_assets_permission(
    action=AssetPermissionAction.Download,
    subject=AssetPermissionSubject(
        type=AssetPermissionSubjectType.All
    ),
    assets=[experience.root_place.get_asset()]
)
>>> <rblxopencloud.AssetPermissionResult granted_asset_ids=[00000000] failed_asset_ids={}>

Setting an asset to be Open Use.

from rblxopencloud import User, AssetPermissionAction,             AssetPermissionSubject, AssetPermissionSubjectType,             AssetPermissionRequest

creator = User(00000000, "...") # initialise with user ID and API key

creator.grant_assets_permission(
    action=AssetPermissionAction.Use,
    subject=AssetPermissionSubject(
        type=AssetPermissionSubjectType.All
    ),
    assets=[
        AssetPermissionRequest(
            asset_id=00000000, # ID of the asset to grant permission for
            grant_dependencies=True
        )
    ]
)
>>> <rblxopencloud.AssetPermissionResult granted_asset_ids=[00000000] failed_asset_ids={}>

Granting a specific user permission to use an asset.

from rblxopencloud import User, AssetPermissionAction,             AssetPermissionSubject, AssetPermissionSubjectType,             AssetPermissionRequest

creator = User(00000000, "...") # initialise with user ID and API key

creator.grant_assets_permission(
    action=AssetPermissionAction.Use,
    subject=AssetPermissionSubject( # subject can also be a User or Group object
        type=AssetPermissionSubjectType.User,
        id=00000000 # ID of the user to grant permission to
    ),
    assets=[
        AssetPermissionRequest(
            asset_id=00000000, # ID of the asset to grant permission for
            grant_dependencies=True
        )
    ]
)
>>> <rblxopencloud.AssetPermissionResult granted_asset_ids=[00000000] failed_asset_ids={}>

`rblxopencloud.CreatorStoreProduct`

Represents an asset as a product on the creator store.

Attributes:

Name	Type	Description
`asset_id`	`int`	The ID of the product's asset.
`asset_type`	`AssetType`	The product's asset type.
`creator`	`Union[User, Group]`	The user or group who created the asset.
`purchasable`	`bool`	Whether the product can be purchased.
`published`	`bool`	Whether the product is considered published from the creator's perspective.
`restrictions`	`list[ProductRestriction]`	A list of restrictions applied to the product.
`base_price`	`Money`	The base price set by the creator.
`purchase_price`	`Money`	The price of the asset to the user, factoring locale-specific considerations.

`fetch_asset`

Fetches the asset information for this product.

Returns:

Type	Description
`Asset`	An `Asset` representing the product's asset.

`rblxopencloud.ToolboxAsset`

Represents an asset in the toolbox.

Attributes:

Name	Type	Description
`creator`	`Union[Creator, User, Group]`	The creator of the asset.
`asset_id`	`int`	The ID of the asset.
`asset_type`	`AssetType`	The type of the asset.
`name`	`str`	The name of the asset.
`description`	`str`	The description of the asset.
`category_path`	`Optional[str]`	The category path of the asset as returned by Roblox. For instance, `3d__props-and-decor`.
`preview_image_asset_ids`	`Optional[list[int]]`	A list of asset IDs for the preview images of the asset.
`preview_video_asset_ids`	`Optional[list[int]]`	A list of asset IDs for the preview videos of the asset.
`created_at`	`datetime`	When the asset was created.
`updated_at`	`datetime`	When the asset was last updated.
`asset`	`Asset`	The asset object. `moderation_result`, `is_archived`, `icon_asset_id`, and revision information is not present. Allows using asset APIs such as asset delivery.
`creator_store_product`	`CreatorStoreProduct`	The creator store product associated with this asset. Contains pricing information. `published`, `restrictions`, `base_price` are not present in the toolbox response.
`try_place_id`	`Optional[int]`	The place ID set for the asset's 'Try in Roblox' button.
`votes_shown`	`bool`	Whether votes are shown for the asset.
`up_votes`	`int`	The number of up votes for the asset.
`down_votes`	`int`	The number of down votes for the asset.
`can_vote`	`bool`	Whether the authenticated user can vote for the asset.
`has_voted`	`bool`	Whether the authenticated user has voted for the asset.
`total_vote_count`	`int`	The total number of votes for the asset.
`up_vote_percentage`	`int`	The percentage of up votes for the asset between 0 and 100.
`subtypes`	`list[ToolboxAssetSubtype]`	For models, the subtypes of the model.
`has_scripts`	`bool`	Whether the asset contains scripts.
`script_count`	`int`	The number of scripts in the model.
`triangle_count`	`int`	For models, the number of triangles in the model.
`vertex_count`	`int`	For models, the number of vertices in the model.
`mesh_part_count`	`int`	For models, the number of mesh parts in the model.
`animation_count`	`int`	For models, the number of animations in the model.
`decal_count`	`int`	For models, the number of decals in the model.
`audio_count`	`int`	For models, the number of audios in the model.
`tool_count`	`int`	For models, the number of tools in the model.
`duration_seconds`	`Optional[int]`	For audio assets, the duration of the audio in seconds.
`artist`	`Optional[str]`	For audio assets, the artist of the audio.
`album`	`Optional[str]`	For audio assets, the album of the audio.
`title`	`Optional[str]`	For audio assets, the title of the audio.
`genre`	`Optional[str]`	For audio assets, the genre of the audio.
`category`	`Optional[str]`	For sound effects, the category of the sound effect.
`subcategory`	`Optional[str]`	For sound effects, the subcategory of the sound effect.
`mesh_asset_id`	`Optional[int]`	For mesh parts, the asset ID of the mesh.
`texture_asset_id`	`Optional[int]`	For mesh parts, the asset ID of the texture.
`facebook_social_link`	`Optional[AssetSocialLink]`	The Facebook social link of the asset.
`twitter_social_link`	`Optional[AssetSocialLink]`	The Twitter social link of the asset.
`youtube_social_link`	`Optional[AssetSocialLink]`	The YouTube social link of the asset.
`twitch_social_link`	`Optional[AssetSocialLink]`	The Twitch social link of the asset.
`discord_social_link`	`Optional[AssetSocialLink]`	The Discord social link of the asset.
`github_social_link`	`Optional[AssetSocialLink]`	The GitHub social link of the asset.
`guilded_social_link`	`Optional[AssetSocialLink]`	The Guilded social link of the asset.
`roblox_social_link`	`Optional[AssetSocialLink]`	The Roblox social link of the asset.
`devforum_social_link`	`Optional[AssetSocialLink]`	The DevForum social link of the asset.
`is_owned`	`Optional[bool]`	Whether the authenticated user owns the asset. Only populated when returned by `search_saved_assets`.
`saved_at`	`Optional[datetime]`	When the authenticated user saved the asset. Only populated when returned by `search_saved_assets`.

Enums

`rblxopencloud.AssetPermissionAction`

Bases: Enum

Enum denoting a permission access action for an asset subject.

Attributes:

Name	Type	Description
`Unknown`	`0`	An unknown or invalid asset permission action.
`Edit`	`1`	The subject can edit the asset.
`Use`	`2`	The subject can use the asset.
`Download`	`3`	The subject can download the asset.
`CopyFromRcc`	`4`	The subject use `AssetService:CreatePlaceAsync()` with this asset.
`UpdateFromRcc`	`5`	The subject can use `AssetService:UpdatePlaceAsync()` with this asset.

Allowed Asset Actions

Asset Type	Subject Type	Actions
Animation, Audio, Mesh Part, Video	Group, Use, Experience	Use
Decal, Image, Mesh	All, Group, Use, Experience	Use
Model	Use	Use, Edit
Model	Group, Experience	Use
Place	All	Download
Place	Experience	CopyFromRcc, UpdateFromRcc

Enabling Download for All on a Place uncopylooks the place.
Allowing All on a Decal, Image, or Mesh means the asset is Open Use.

`rblxopencloud.AssetPermissionResultError`

Bases: Enum

Enum denoting a failure reason for an asset permission grant request.

Attributes:

Name	Type	Description
`Unknown`	`0`	An unknown or invalid asset permission action.
`InvalidRequest`	`1`	The request was invalid.
`AssetNotFound`	`2`	The specified asset could not be found.
`CannotManageAsset`	`3`	The asset cannot be managed.
`PublicAssetCannotBeGrantedTo`	`4`	The asset is already Open Use.
`CannotManageSubject`	`5`	The subject cannot be managed.
`SubjectNotFound`	`6`	The specified subject could not be found.
`AssetTypeNotEnabled`	`7`	The asset type is not enabled for permissions.
`PermissionLimitReached`	`8`	The permission limit has been reached.
`DependenciesLimitReached`	`9`	The dependencies limit has been reached.

`rblxopencloud.AssetPermissionSubjectType`

Bases: Enum

Enum denoting a permission subject type for an asset.

Attributes:

Name	Type	Description
`Unknown`	`0`	An unknown or invalid asset permission subject type.
`All`	`1`	Everyone on Roblox.
`User`	`2`	A specific user on Roblox.
`Group`	`3`	A specific group on Roblox.
`Experience`	`4`	A specific experience on Roblox.

`rblxopencloud.AssetType`

Bases: Enum

Enum denoting an Asset's asset type.

Attributes:

Name	Type	Description
`Unknown`	`0`	The asset type is unknown/unsupported.
`Decal`	`1`
`Audio`	`2`
`Model`	`3`
`Plugin`	`4`	Only for fetching assets; does not support uploading.
`FontFamily`	`5`	Only for fetching assets; does not support uploading.
`MeshPart`	`6`	Only for fetching assets; does not support uploading.
`Video`	`7`	Only for fetching assets; does not support uploading.
`Animation`	`8`	Only for fetching assets; does not support uploading.
`Image`	`9`	Only for fetching assets; does not support uploading.
`Place`	`10`	Only for fetching assets; does not support uploading.
`StorePreviewVideo`	`11`	A special type of video for store preview videos. Only for fetching assets; does not support uploading.
`ClassicTShirt`	`100`	Only for fetching assets; does not support uploading.
`Hat`	`101`	Only for fetching assets; does not support uploading.
`ClassicShirt`	`102`	Only for fetching assets; does not support uploading.
`ClassicPants`	`103`	Only for fetching assets; does not support uploading.
`ClassicHead`	`104`	Only for fetching assets; does not support uploading.
`Face`	`105`	Only for fetching assets; does not support uploading.
`Gear`	`106`	Only for fetching assets; does not support uploading.
`Torso`	`107`	Only for fetching assets; does not support uploading.
`RightArm`	`108`	Only for fetching assets; does not support uploading.
`LeftArm`	`109`	Only for fetching assets; does not support uploading.
`LeftLeg`	`110`	Only for fetching assets; does not support uploading.
`RightLeg`	`111`	Only for fetching assets; does not support uploading.
`Package`	`112`	Only for fetching assets; does not support uploading.
`HairAccessory`	`113`	Only for fetching assets; does not support uploading.
`FaceAccessory`	`114`	Only for fetching assets; does not support uploading.
`NeckAccessory`	`115`	Only for fetching assets; does not support uploading.
`ShoulderAccessory`	`116`	Only for fetching assets; does not support uploading.
`FrontAccessory`	`117`	Only for fetching assets; does not support uploading.
`BackAccessory`	`118`	Only for fetching assets; does not support uploading.
`WaistAccessory`	`119`	Only for fetching assets; does not support uploading.
`ClimbAnimation`	`120`	Only for fetching assets; does not support uploading.
`DeathAnimation`	`121`	Only for fetching assets; does not support uploading.
`FallAnimation`	`122`	Only for fetching assets; does not support uploading.
`IdleAnimation`	`123`	Only for fetching assets; does not support uploading.
`JumpAnimation`	`124`	Only for fetching assets; does not support uploading.
`RunAnimation`	`125`	Only for fetching assets; does not support uploading.
`SwimAnimation`	`126`	Only for fetching assets; does not support uploading.
`WalkAnimation`	`127`	Only for fetching assets; does not support uploading.
`PoseAnimation`	`128`	Only for fetching assets; does not support uploading.
`EmoteAnimation`	`129`	Only for fetching assets; does not support uploading.
`TShirtAccessory`	`130`	Only for fetching assets; does not support uploading.
`ShirtAccessory`	`131`	Only for fetching assets; does not support uploading.
`PantsAccessory`	`132`	Only for fetching assets; does not support uploading.
`JacketAccessory`	`133`	Only for fetching assets; does not support uploading.
`SweaterAccessory`	`134`	Only for fetching assets; does not support uploading.
`ShortsAccessory`	`135`	Only for fetching assets; does not support uploading.
`LeftShoeAccessory`	`136`	Only for fetching assets; does not support uploading.
`RightShoeAccessory`	`137`	Only for fetching assets; does not support uploading.
`DressSkirtAccessory`	`138`	Only for fetching assets; does not support uploading.
`EyebrowAccessory`	`140`	Only for fetching assets; does not support uploading.
`EyelashAccessory`	`141`	Only for fetching assets; does not support uploading.
`MoodAnimation`	`142`	Only for fetching assets; does not support uploading.
`DynamicHead`	`143`	Only for fetching assets; does not support uploading.
`LocalizationTableManifest`	`149`	Only for fetching assets; does not support uploading.
`LocalizationTableTranslation`	`150`	Only for fetching assets; does not support uploading.
`TexturePack`	`151`	Only for fetching assets; does not support uploading.
`FontFace`	`152`	Only for fetching assets; does not support uploading.
`MeshHiddenSurfaceRemoval`	`153`	Only for fetching assets; does not support uploading.
`CodeSnippet`	`154`	Only for fetching assets; does not support uploading.
`AdsVideo`	`155`	Only for fetching assets; does not support uploading.
`App`	`156`	Only for fetching assets; does not support uploading.
`Code`	`157`	Only for fetching assets; does not support uploading.
`Lua`	`200`	Only for fetching assets; does not support uploading.
`Badge`	`201`	Only for fetching assets; does not support uploading.
`GamePass`	`202`	Only for fetching assets; does not support uploading.

`rblxopencloud.InstanceType`

Bases: Enum

Enum denoting instance type. Used for filtering in the toolbox search.

Attributes:

Name	Type	Description
`Unknown`	`0`	An unknown or invalid instance type. Not used.
`Script`	`1`	Represents a script instance type.
`MeshPart`	`2`	Represents a mesh part instance type.
`Decal`	`3`	Represents a decal instance type.
`Animation`	`4`	Represents an animation instance type.
`Audio`	`5`	Represents an audio instance type.
`Tool`	`6`	Represents a tool instance type.

`rblxopencloud.ModerationStatus`

Bases: Enum

Enum denoting the current moderation status of an asset.

Attributes:

Name	Type	Description
`Unknown`	`0`	The current moderation status is unknown.
`Reviewing`	`1`	The asset has not completed moderation yet.
`Rejected`	`2`	The asset failed moderation.
`Approved`	`3`	The asset passed moderation.

`rblxopencloud.MusicChartType`

Bases: Enum

Enum denoting music chart type. Used for filtering in the toolbox search.

Attributes:

Name	Type	Description
`Unknown`	`0`	An unknown or invalid music chart type. Not used.
`Current`	`1`	Represents the current music chart on Roblox.
`Week`	`2`	Represents the music chart for the past week on Roblox.
`Month`	`3`	Represents the music chart for the past month on Roblox.
`Year`	`4`	Represents the music chart for the past year on Roblox.

`rblxopencloud.ProductRestriction`

Bases: Enum

Enum denoting a restriction applied to a creator store product.

Attributes:

Name	Type	Description
`Unknown`	`0`	An unknown restriction that was returned by Roblox.
`Unspecified`	`1`	An unspecified restriction returned by Roblox.
`ItemRestricted`	`2`	The item is restricted.
`SellerTemporarilyRestricted`	`3`	The seller is temporarily restricted.
`SellerPermanentlyRestricted`	`4`	The seller is permanently restricted.
`SellerNoLongerActive`	`5`	The seller is no longer active.

`rblxopencloud.ToolboxAssetSubtype`

Bases: Enum

Enum denoting the subtype of a model in the toolbox.

Attributes:

Name	Type	Description
`Unknown`	`0`	An unknown or invalid model subtype.
`Ad`	`1`	A model is an ad subtype relating to immersive advertising.
`MaterialPack`	`2`	A model is a material pack subtype.
`Package`	`3`	A model is a package meaning it supports dynamic auto updating in experiences.

`rblxopencloud.ToolboxSearchContext`

Data class containing meta information about search results in the toolbox.

Attributes:

Name	Type	Description
`total_results`	`int`	The total number of results for the search query.
`filtered_keyword`	`str`	The keyword that was used for the search after filtering by Roblox.
`applied_facets`	`list[str]`	The list of facet filters that were applied to the search.
`available_facets`	`list[str]`	The available facet filters that can be applied to the search.

`rblxopencloud.ToolboxSearchSortCategory`

Bases: Enum

Enum denoting the category to sort by when searching the toolbox or saved assets.

Attributes:

Name	Type	Description
`Unknown`	`0`	An unknown or invalid sort category. Not used.
`Relevance`	`1`	For searching by the toolbox, sort by relevance to the search query. This is the default sort category.
`Trending`	`2`	For searching by the toolbox, sort by how trending the asset is on Roblox.
`Top`	`3`	For searching the toolbox or saved assets, sort by the top rated assets on Roblox.
`AudioDuration`	`4`	For searching by the toolbox for audio assets, sort by the duration of the audio.
`CreateTime`	`5`	For searching by the toolbox, sort by when the asset was created.
`UpdateTime`	`6`	For searching by the toolbox or saved assets, sort by when the asset was last updated.
`SaveTime`	`7`	Only for searching saved assets, sort by when the asset was saved.
`Name`	`8`	Only for searching saved assets, sort alphabetically by name of the asset.
`Creator`	`9`	Only for searching saved assets, sort alphabetically by creator name of the asset.
`AssetType`	`10`	Only for searching saved assets, sort by asset type.
`Price`	`11`	Only for searching saved assets, sort by price of the asset.