Manage your presence on the [Creator Store](/production/creator-store). [Create](#Cloud_CreateCreatorStoreProduct) and [update](#Cloud_UpdateCreatorStoreProduct) product listings for your assets, and [search the toolbox](#Toolbox_SearchCreatorStoreAssets) for assets using various filters.


The type of audio (Music or SoundEffect).

The duration of the audio file in seconds.

Audio types to include (e.g. Music, SoundEffect)

The maximum duration for audio in seconds. If included, must be greater than or equal to 1.

The minimum duration for audio in seconds. If included, must be greater than or equal to 0.

Indicates which music charts to filter from.

Response model for bulk delete saves operation

Number of saves that were successfully deleted

Custom collections are not currently supported.
This field should be omitted.

Deprecated: Please refer to the 'userId' and 'groupId' properties instead.
The creator type and ID. E.g. user/123 or group/456.

The Group ID. Required if the asset is group-owned.

This value only exists for group-based creators and represents the User ID of the creator who most recently updated the asset.

This value only exists for group-based creators and represents the name of the creator who most recently updated the asset.

The User ID of the creator. Required if the asset is individual-user-owned.

Represents the capabilities that a model has (e.g. sandboxing).
Only present for model asset types; AMRS includes it in the response when available.

Controls whether the model will be sandboxed upon insertion when it has scripts.

Represents a product in the Creator Store. This resource is used to manage
distribution and pricing of assets on the Creator Store.

The Creator Store product is an audio file with this asset ID.

The Creator Store product is a decal with this asset ID.

The Creator Store product is a font family with this asset ID.

The Creator Store product is a mesh part with this asset ID.

The Creator Store product is a model with this asset ID.

The resource path of the creator store product.

Format: `creator-store-products/{creator_store_product_id}`

The Creator Store product is a plugin with this asset ID.

Supported base prices in USD: $0, $4.99, $5.99, $6.99, $7.99, $8.99,
$9.99, $10.99, $11.99, $12.99, $13.99, $14.99, $15.99, $16.99, $17.99,
$18.99, $19.99, $24.99, $29.99, $34.99, $39.99, $44.99, $49.99, $59.99,
$69.99, $79.99, $89.99, $99.99, $149.99, $199.99, $249.99

Whether the seller intends to distribute the Creator Store product on
the Creator Store. A seller might intend to distribute a product, but due
to some restrictions on the seller or underlying Creator Store product, the
product may not be available for purchase. See
`restrictions` and `purchasable` for more details.

Whether the product is purchasable.

For this value to be true, `published` must be true and `restrictions` must
be empty. If this value is false, the product may not be acquired by any
user.

Restrictions applied to the product. A product can have multiple
restrictions active at one time.

Possible values:

  | Value | Description |
  | --- | --- |
  | RESTRICTION_UNSPECIFIED | Unspecified restriction. |
  | SOLD_ITEM_RESTRICTED | The item being sold has been restricted by Roblox  Details may be available by looking up that item directly. |
  | SELLER_TEMPORARILY_RESTRICTED | The product is restricted because the seller's account is temporarily restricted by Roblox. |
  | SELLER_PERMANENTLY_RESTRICTED | The product is restricted because the seller's account is permanently restricted by Roblox. |
  | SELLER_NO_LONGER_ACTIVE | The product is restricted because the seller's account was deleted or is otherwise no longer active. |

The Creator Store product is a video with this asset ID.

Represents a decimal number in a form similar to scientific notation.

Examples:
 - 17            === `{significand: 17   exponent: 0} (or just {significand:
   17})`
 - -0.005        === `{significand: -5   exponent: -3}`
 - 33.5 million  === `{significand: 335  exponent: 5}`
 - 11/8 (1.375)  === `{significand: 1375 exponent: -3}`

Note that the range of a Decimal exceeds that of a JSON `number` (double), as
well as that of a `decimal64`.

Represents the position of the decimal point within the significand.

When the exponent is 0, the value of the Decimal is simply the value of
`significand`.

When the exponent is greater than 0, represents the number of trailing
zeroes after the significant digits.

When the exponent is less than 0, represents how many of the significant
digits (and implicit leading zeroes, as needed) come after the decmial
point.

The total number of saves that match the query.

A save record, hydrated with the asset details.

Represents the count of various instance types within an asset.
See [Instance](https://create.roblox.com/docs/reference/engine/classes/Instance).

Script capabilities for the asset (sandboxing)

The number of studio Instance types in the model.
See [Instance](https://create.roblox.com/docs/reference/engine/classes/Instance).
These are broken down into specific types, such as MeshPart, Part, Script,
Tool, Animation, etc.

The summary of the meshes within the model, if they exist.

The number of scripts that are in the model.

A list of model instance types. See Toolbox.Service.Models.Internal.InstanceCounts and [Instance](https://create.roblox.com/docs/reference/engine/classes/Instance) for more details.

If included, excludes assets with these subtypes.

This filters that the following [Instance](https://create.roblox.com/docs/reference/engine/classes/Instance) types are included in the model.

If included, search for assets only with these subtypes.

Represents an amount of money with its currency type.

Examples:
 - Five US dollars === `{currency_code: "USD" quantity: {significand: 5}}`

A currency code.

This may be a three-letter currency code defined in ISO 4217.

APIs may define additional currency codes that are not included in the ISO
4217 standard (for example, virtual currencies or cryptocurrencies). These
must start with `X-`, in order to distinguish them from potential future
ISO 4217 codes. For example, `"USD"` is the ISO 4217 code for United States
dollar.

Represents which music chart to pull entries from, if any

Provides a summary of the mesh characteristics of an object, such as triangle and vertex counts.

The total number of triangles in the object's mesh.

The total number of vertices in the object's mesh.

The number of scripts that are in the plugin.

Grouped preview asset ids for an item, separated by media type.

Contains query correction information for a search query.

The suggested spelling correction for the original search query.

Facets that are already applied to the search.

Represents audio type values that will be properly displayed in Swagger UI.

This represents a "subset" of Toolbox.Service.CategoryType options and represent the full set
of "categories" (or asset types) that can be searched upon from the toolbox search API.

Request model for searching Creator Store assets.

The Group ID of the creator. Only one of 'userId' and 'groupId' can be present in a query.

The image file to search by. The image must be base64 encoded to be used in the search. Only one of 'query' and 'image' can be present in a query.

Whether the results should only include assets created by verified creators.

The number of assets to be returned. Cannot be larger than 100.

The maximum price of the asset in cents. If included, must be greater than or equal to 0.

The minimum price of the asset in cents. If included, must be greater than or equal to 0.

The page number to retrieve, starting from 0. Only one of 'pageNumber' and 'pageToken' can be present in a query.

The identifier for the desired search results page. Only one of 'pageNumber' and 'pageToken' can be present in a query.

The search terms used to filter the results. Only one of 'query' and 'image' can be present in a query.

The asset type to search within. Optional when Toolbox.Service.SearchCreatorStoreAssetsRequest.CategoryPath
resolves to an asset type; otherwise required.

Indicates which fields will be populated in the response.

The category to sort the search results by.

The sort direction of the search results.

Optional swimlane identifier (e.g. "trending", "essential", "priced").

The User ID of the creator. Only one of 'userId' and 'groupId' can be present in a query.

The response for the SearchCreatorStoreAssets endpoint.

The list of creator store assets returned by the search query.

The filtered keyword that was used to search for assets, if applicable.

The page token to view the next page of results.

Query correction information, if a correction was available for the search query.

The applied and available facets of a query.

The total number of results for the given search query.

This view controls which fields are populated in the search response. A lighter
view will result in faster response times and higher reliability.

Represents the direction in which to sort the results

Category Path of the asset, if it exists.
e.g. "3d__characters"

Universe ID if the asset was created within a specific universe.

The asset's preview asset ids grouped by asset type.

The social links associated with the asset.

The asset's creator store product information.

Whether or not the asset can be purchased in the Creator Store.

The price of the asset, including the currency code.

The percentage of total votes that have been UpVotes

A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.

x-api-key

A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.

.ROBLOSECURITY

Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.

The Roblox API. See https://create.roblox.com/docs/cloud/open-cloud for more details.

Roblox API

Add a Creator Store product. Only use this method if your product has never
been distributed on the Creator Store; otherwise, use the `PATCH` method to
update the product.

CreatorStoreProduct

creator-store-product:write

creator_store_product_id

creator-store-product:read

updateMask

If set to true, and the creator store product is not found, a creator store
product is created. In this situation, `update_mask` is ignored.

allowMissing

targetType

targetId

Custom collections are not currently supported. This field should be omitted.

collectionName

creator-store-save:write

The ID of the asset to filter by. If provided, targetType must also be provided.

sortBy

sortDirection

limit

The page number to return, starting from 1

page

keyword

hideOwnedAssets

creator-store-save:read

Bulk deletes saves.
Max of 5000 saves per request.

Get details for a single Creator Store asset.

The asset type to search within. Optional when categoryPath is present in the request; otherwise required.

searchCategoryType

The search terms used to filter the results.

query

When searching for models, the subtypes associated with the search results.

modelSubTypes

When searching for models, the subtypes not associated with the search results.

excludedModelSubTypes

Deprecated: Please refer to the 'userId' and 'groupId' properties instead. The creator type and ID. E.g. "user/123" or "group/456"

creator

userId

groupId

pageToken

pageNumber

maxPageSize

sortCategory

When searching for audio, the minimum duration of the audio assets. If included, must be greater than or equal to 0.

audioMinDurationSeconds

When searching for audio, the maximum duration of the audio assets. If included, must be greater than or equal to 0.

audioMaxDurationSeconds

When searching for audio, the artist name of the audio assets.

audioArtist

When searching for audio, the album name of the audio assets.

audioAlbum

When searching for audio, the type of the audio assets.

audioTypes

When searching for models, this filters that the following [Instance](https://create.roblox.com/docs/reference/engine/classes/Instance) types are included in the model.

includedInstanceTypes

includeOnlyVerifiedCreators

minPriceCents

maxPriceCents

facets

categoryPath

searchView

musicChartType

swimlane

Creator Store

Experiences

Avatar

Assets

Samples and projects

Engine API

Open Cloud API

Studio

Analytics

Platform

Tutorials

Creator programs

Education

Courses

Learn

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Beta endpoints are ready for public use. Breaking changes are possible but rare.

These Open Cloud documentation pages will be removed on March 31, 2026. You will be automatically redirected to the new Open Cloud documentation at that time. {linkStart}Learn more{linkEnd}

These old Open Cloud pages will be removed and redirected on March 31, 2026. {linkStart}Learn more{linkEnd}

Experimental endpoints are ready for public use, but may experience breaking changes occasionally as the API contract is finalized.

This endpoint can be called in-experience through {httpServiceLinkStart}HttpService{httpServiceLinkEnd} with an API key.

This field may be set when creating a resource, but may not be modified by subsequent requests.

These fields may be set when creating a resource, but may not be modified by subsequent requests.

This field may be provided in requests, but will never be included in responses.

Legacy authentication method. Always prefer using API Key or OAuth 2.0 when available.

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

Requires no authentication to call. Typically has significantly lowered rate limits. Always prefer using API Key or OAuth 2.0 when available.

For each grouping, only one of the following fields in the schema has to be provided, the remaining can be excluded.

You can opt back in at any time. {linkStart}Provide feedback.{linkEnd}

You are viewing the old docs. {linkStart}Provide feedback.{linkEnd}

You can opt out at any time and be redirected back to the old reference pages. {linkStart}Provide feedback.{linkEnd}

You are viewing the revamped docs. {linkStart}Provide feedback.{linkEnd}

This field may be set on responses, but will be ignored in requests.

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. [Learn more about rate limits]({link}).

{limit} requests per day across all API keys for a user or group

{limit} requests per hour across all API keys for a user or group

{limit} requests per minute across all API keys for a user or group

{limit} requests per second across all API keys for a user or group

{limit} requests per minute per API key owner

{limit} request(s) per second per API key owner

Scopes control what permissions your credentials have. Your credentials can only access the endpoints supported by the scopes you selected.

Stable endpoints are production-ready and will almost never experience breaking changes during their lifetime.

This target enables you to limit your key's access to selected {requiredParts}

This target enables you to limit your key's access to selected {requiredParts} and {optionalParts}

Target types are used to restrict the resources that your credentials have permissions on. Only the selected resources can be acted on even if your account has permissions on additional resources. Some scopes do not have target parts. In these cases, all of your relevant resources can be acted on.

The universe Top Level Part does not need to be selected for user-owned API Keys. In this case, your API Key will have access to all of your user-owned experiences and group-owned experiences that you have the right group permissions on.

Try It Out is not yet supported for endpoints requiring API key or OAuth 2.0 authentication

Cookie authentication is disabled for high risk operations for safety.

Critical risk endpoints are extremely sensitive and Try It Out is disabled for safety

Note: Authentication headers are not included in this code sample. You may need to add an authentication header for this command to work.

This is a high risk endpoint that can modify or delete critical data. Use extreme caution when testing.

This API endpoint has been classified as HIGH RISK and may affect live data or user accounts.

Authenticated requests to high-risk APIs can make changes that cannot be undone. Please review your request parameters carefully before proceeding.

Please login to use cookie authentication

This is a low risk endpoint that retrieves data. This is generally safe to test.

This is a medium risk endpoint that modifies data. Test carefully with non-critical accounts, as changes may be permanent.

To keep your account safe, never paste text here from other sources or send information from this page to others.

You are about to test live API endpoints using your actual account credentials.

Only proceed if you understand the implications of the API calls you're about to make. Review the API documentation carefully before testing.

API calls will be made using your authenticated session

These are real API calls that may affect your account or data

Rate limits and other API restrictions apply

Some operations may modify or delete data

This endpoint has been superseded by these recommended alternative endpoints:

The following scopes are required to call this endpoint. For more
information on generating proper keys, see [Manage API keys]({apiKeyReferenceDocLink}).

For more information on generating keys, see [Manage API keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

This string is formatted as a [FieldMask](/cloud/reference/types#fieldmask).

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

The following scopes are required to call this endpoint.

Resource Paths

This string is formatted as a [Timestamp](/cloud/reference/types#timestamp).

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

Creator Store

Assets

Not Recommended