Pending updates

Adds a Trigger-type parameter to the Animation Graph Editor that, when set to true, auto-resets at the start of the next frame to false. Useful for setting the `Trigger` property on `Enum.AnimationNodeType.OneShotNode`.

Adds spatial query in-radius filter to `Datatype.Instance:QueryDescendants()`.

Adds the `AutoLocalize` property to `Class.AudioTextToSpeech`, allowing you to control whether real-time text-to-speech content is automatically localized.

Adds support for CalyxOS to Android attestation for Pixel 6 and above / Fairphone 4 and above.

In the New Type Solver, resolve more instances of internal errors due to hitting recursion limits.

If a script analysis warning or hovertype tooltip needs to display the type of a table with a metatable, it will now say `setmetatable<tbl, mt>` instead of `{ @metatable mt, tbl }`.

Fixes an issue where default `Class.PlayerScript` objects would error with calling new coroutines in simulation callbacks when interfacing with the Character Controller Library.

Fixes inconsistent lighting between `Class.ViewportFrame` objects sharing the same `Class.Sky`.

Fixes mouse focusing bug during studio play testing, and mouse delta spikes when entering first-person point of view.

Fixes normal map lighting on rotated `Class.Decal` and `Class.Texture` objects.

Fixes a crash that could occur when uploading a UGC color map.

Additional logging on crash reporter initialization failures to support faster turn-around fixes.

Allows external MCP clients to connect to Studio without opening the Assistant plugin first.

Adds air buoyancy, water buoyancy, and water drag forces to visualization of mechanism fluid forces.

Adds `MapTVRemoteToGamepadKeycodes` rollout state property under `Workspace` for enabling whether the experience should automatically map TV remote keycodes to legacy gamepad keycodes, enabled by default.

Enables in-experience publishing through Opaque Content.

Adds `Enum.AnimationNodeType.OneShotNode` to the animation graph.

Greatly reduces the overhead of Luau metamethod lookup for metatables frozen by `table.freeze`.

Set `UserInputService.PreferredInput` to `Enum.PreferredInput.MicroGamepad|MicroGamepad` for when a player has connected or most recently interacted with a gamepad without a thumbstick (for example, a TV remote or another limited-input gamepad).

Introduces `ChatWindowConfiguration.TextChannelDisplayMode` which allows creators to describe whether all TextChannels (previous default behavior) or only channels created via `TextChatService.CreateDefaultTextChannels` will render in the primary experience chat window.

Studio upgrades Cameras into ViewportCameras with the same properties upon insertion (paste or import rbxm) to avoid authoring complications around ThumbnailCameras and ViewportFrames.

Fixes a Luau autocomplete bug that prevented suggestions being presented at various scopes in a program.

Fixes issue with tools not streaming to some clients.

glTF export now logs a warning when it omits a part because that part's mesh produced no geometry, and the warning includes the part's mesh content id so the omission can be matched against the asset fetch that failed. Previously the part was dropped with no node, no mesh, and no log line, and the export still reported success. The exported glTF is unchanged; this only adds log output, behind FFlagGltfExportLogOmittedInstances, which is off by default.

glTF asset export now treats materials with no explicit metalness map (plain colored parts, classic textures, and SurfaceAppearances with only an albedo/normal map) as dielectric — metallic_factor defaults to 0 instead of 1 — so exported avatars and parts no longer render near-black under image-based lighting. Materials that carry a metalness map are unaffected. Gated behind FFlagGltfExportDielectricMetallicDefault (default off).

Fixes empty MeshParts becoming much darker after FragmentAsync or other solid-modeling operations.

Fixes bug where Roblox Studio could crash after publishing a place for the first time.

Fixes a bug where Luau's type analysis would be overly permissive, leading to false negatives, when checking the bodies of generic functions in strict mode.

For example, functions like `function call<T>(f: (T) -> T) f(nil) end` will no longer type check in strict mode since `nil` is not of the generic type `T`.

Keeps auto save files when a studio user is kicked out of their place from a ban moderation.

Adds `Class.RunService:BindToAnimation()` for running fixed frequency callbacks prior to animation updates.

Fixes a visual glitch where the Audio Equalizer grid appears on top of the curve handles.

In the New Luau Type Solver, read-only indexers now have the correct behavior when unifying against invariant indexers.

Introduces `Class.TextChannel.AddPlayersOnJoin|AddPlayersOnJoin` property. When set to `True`, all `Player`s who join the `Datamodel` will automatically become a participant of the `TextChannel`.

Adds a `Class.Folder.IconTint` property. The hue part of the color is used to tint the folder icon. `CustomFolder.svg` is used as the base for tinting, so custom icon sets should include this to support `Folder` tinting. Every hue is available... please tint responsibly!

Adds `Class.UIShadow.Mode` with values `Shape` and `Text`. The latter applies shadows to text.

Fixes a spurious server-side warning ("RunService:setPredictionMode() should not be called on the server.") that was logged when `Class.RunService.SetPredictionMode|SetPredictionMode` was called from code shared between client and server. On the authoritative server this call is a no-op, so developers no longer need to guard it with `RunService:IsClient()`.

Fixes collision geometry loading for toolbox `MeshPart` items. There was a regression in loading of older published assets that caused the Collision Fidelity to reset to Box collision.

Fixes an issue where getting certain services would cause any joining user to immediately crash.

Fixes server authority auto-prediction logic when assemblies change.

Fixes a bug that caused changing attribute types to sometimes disconnect a player when using `Class.Workspace.NextGenerationReplicationEnabled|NextGenerationReplicationEnabled`.

Adds makeup decal export for FACS dynamic heads when exporting to glTF.

Fixes a Server Authority bug where a part or character with `PredictionMode` set to `Off` was still simulated locally on the client while inside the local player's simulation region, causing it to drift from its server-authoritative position (for example, a character dropping to the ground instead of staying where the server placed it). Parts explicitly set to `Off` are no longer locally predicted through the simulation-region path. Contact simulation — when an `Off` object physically touches a locally-simulated object — is unchanged.

Adds new `Class.WorldRoot` APIs: `Class.WorldRoot:Simulate()|Simulate()`, a scriptable physics stepping method, `Class.WorldRoot.SimulationRate|SimulationRate`, a scriptable percentage scaling the rate of simulation, and `Class.WorldRoot.AutoSimulate|AutoSimulate`, a scriptable boolean property determining whether a world continuously and automatically steps physics.

Caps the frame-time spent in the `Sound` job. This allows the engine to play an unlimited number of audio files at once, but makes property updates and looped/ended events more latent at mega-scale.

In the New Luau Type Solver, fixes an instance of generic types leaking into table indexers.

Add inferred type information for `Class.Instance:QueryDescendants()`.

In the New Luau Type Solver, errors are now correctly reported for function calls that make use of the `__call` metamethod.

In the New Luau Type Solver, fixes many (if not all) cases of an internal compiler exception due to hitting recursion limits while analyzing free types ("Internal recursion counter exceeded in FreeTypeSearcher / FreeTypeFinder").

Fixes a Roblox Studio editor bug where clicking **Go to Declaration** on a variable that is cast to a function type may cause IDE features like autocomplete and script analysis to be disabled, and Studio to hang.

Preset chat messages are no longer delivered to a recipient when the preset is not approved for the language that recipient reads chat in. Applies to both in-experience and global (cross-server) chat.

Renames `PromptCreateAssetAsync` to `PromptCreatePlatformContentAsync`, and adds support for `Image` asset creation by publishing an `EditableImage`.

Fixes a regression where `Class.TextLabel`/`Class.TextButton` with `RichText` and `TextScaled` enabled could wrap text in the middle of a word instead of at word boundaries.

Moves `Sound/updateFmod` to a background thread, to avoid spending frame-time on this.

Fixes a Luau bug where type instantiation would not report an error in strict mode if the provided type argument was incorrect, for example `useState<<Intance>>`.

Luau will no longer produce "Subtyping test returned a reasoning with an invalid path" errors when a type mismatch with a negation type occurs.

Fixes an issue where `Class.UIDragDetector|UIDragDetectors` did not work for virtual cursors on `Class.GuiObject|GuiObjects` that were selected.

Adds `Class.Decal.EmissiveMaskContent|EmissiveMaskContent`, `Class.Decal.EmissiveStrength|EmissiveStrength`, and `Class.Decal.EmissiveTint|EmissiveTint` to `Class.Decal` objects.

When `PlayerCharacterDestroyBehavior` is enabled, Players will now wait some amount of seconds before being destroyed.

In the New Luau Type Solver, fixed a potential crash when using `types.negationof` in a type function.

In the new Luau type solver, resolve an instance Luau previously unsoundly simplified an array like table even if the elements were not coincident.

Makes `Class.AudioReverb`, `Class.ReverbSoundEffect`, and `Class.SoundService.AmbientReverb` 15-40% faster.

In the New Luau Type Solver, unannotated lambdas in tables are now correctly made generic when it is reasonable.

Adds two properties to `Class.TextChannelWindow` for chat-window font customization: `Class.TextChannelWindow.OverrideFont|OverrideFont` and `Class.TextChannelWindow.FontFace|FontFace`.

Fixes Studio crashes from rendering custom icons.

Lets users reactivate banned accounts on the Studio moderation dialog, if the ban has expired.

Fixed a bug where a MeshPart/DynamicHead avatar's name billboard was hidden at typical viewing angles when name occlusion was enabled.

In the New Luau Type Solver, fixes a bug where `setmetatable()` would nest, rather than override, the metatable of a given table.

Fixes `Class.ViewportCamera` so authored instances are no longer destroyed when Studio changes the current camera.

Adds `require("@rbx/PlayerModule")` if opted into `Class.Workspace.PlayerScriptsUseInputActionSystem`.

`Class.UIShadow` can now be affected by a child `Class.UIGradient`.

When completing method calls in the script editor, autocomplete now automaticallys replace a dot with a colon when necessary. (eg a.Find to a:FindFirstChild() )

Adds a new instance type: PlayerControlState for replicating scripted inputs in Server Authority.

Improves performance when calling CreateDataModelContentAsync from a DataModelContent mesh.

Scripts inside a nested sandboxed container that declares `AccessOutsideWrite` can now access instances up to their parent container's isolation boundary, rather than losing all outside access when an ancestor container withholds AOW.

Fixes textbox focus sometimes getting stuck on consoles.

Fixes an issue where tags on `ServerStorage` were deleted when using Team Create.

Adds new `Class.EditableImage` function called `SampleImageProjected` that's the opposite of `Class.EditableImage.DrawImageProjected|DrawImageProjected`, with the projection defining how to sample texels from the source texture onto the decal texture.

Adds additional `Class.EditableImage` blending mode: `ImageCombineType.Subtract`. Subtract subtracts source image color and alpha from the destination image.

Updates the language of the error diagnostics for type mismatch errors in Luau to be more succinct and easier to understand.

In the New Luau Type Solver, fixes an issue where inferring an indexer on a table would result in `unknown` rather than the actual indexer type.

Introduces a new Studio Beta called Collections.

Allows the `AnimationId` field in the `Enum.AnimationNodeType.ClipNode` to connect to a parameter and set at runtime via `Class.AnimationTrack.SetParameter|AnimationTrack:SetParameter`.

Changes the parameter count limit for an animation graph from a hard limit that prevents the graph from playing to a soft limit that allows the graph to continue with a warning about incompatibility with Server Authority.

Fixes a bug where accessory `Class.SurfaceAppearance.Color` was not applied in the website 3D catalog view.

Fixes `Class.TextBox.TextEditable` to dismiss native keyboard editing when this property is set to false while the user is focused on the `TextBox`.

Adds new `Class.GuiObject.InputSink|InputSink` property for UI that allows for the deprecation of the `Class.GuiObject.Active|Active` property.

Fixes an issue where looping sounds could loop-back prematurely.

Fixes an issue where changing `Class.SoundService.RolloffScale` might not affect a `Class.Sound` until it or the listener moves.

Fixes an issue where right-clicking on Mac Studio sometimes wouldn't close context menus.

Adds the `MemoryStoreDistributedCounter` data structure to the `MemoryStoreService` with support for `GetAsync()` and `IncrementAsync()` methods.

Adds `Class.UIShadow.Inset|Inset`, which allows you to specify a `Class.UIShadow` to be rendered above and within the parent element, and `Class.UIShadow.ShowBehindParent|ShowBehindParent`, which allows you to show or hide the part of `Class.UIShadow` that's behind the parent element.

Adds min and max value controls to the `NumberSequence` editor in QT Properties.

Scripts can now rename a player's Character model at any point in its lifecycle. The name lock that previously blocked renames without `WritePlayer` is no longer applied.

Fixes a bug where tables containing a `message` key were not fully output when passed to `error`.

Fixes a bug where animation retargeting could produce incorrect results when avatar limbs are missing.

Fixes the `AccessOutsideWrite` capability for sandboxed `ModuleScripts`.

"Remove from list" no longer appears in the context menu of local files in the Experiences page.

Moves collision group APIs from `Class.PhysicsService` to `Class.WorldRoot` so that each `Class.WorldModel` can register and configure its own collision groups independently of `Class.Workspace`. Enable `Class.WorldModel.UseWorkspaceCollisionGroups|UseWorkspaceCollisionGroups` to have a `Class.WorldModel` use `Class.Workspace` collision groups for simulation instead of its own.

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}).

Not Recommended

You are viewing the revamped Open Cloud reference.

You've opted out of the new Open Cloud reference.

View your ad campaigns and their performance.

Create, update, and manage your ad campaigns.

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This allows viewing asset permissions for subjects (including groups and experiences) and assets your account has access to.

This allows granting asset permissions to any subjects (including groups and experiences) and assets your account has access to.

This allows you to view the status and results of avatar auto-setup jobs on your behalf.

This allows you to create and manage avatar auto-setup jobs on your behalf.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows making changes to your synced commerce items.

This allows viewing information about your commerce merchant connections.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows you to view information about your Creator Store saves.

This allows you to modify information about your Creator Store saves.

Grants access to create data stores on your behalf.

Grants access to delete data stores on your behalf.

Grants access to read a list of data stores.

Grants access to take a snapshot of your data stores.

Grants access to create entries in your data stores.

Grants access to mark specified entries for deletion.

Grants access to list your data store's entries.

Grants access to read specified entries in your data stores.

Grants access to update the value, attributes, and users of an entry.

Grants access to delete revisions of your data store's entries.

Grants access to list revisions for your data store's entries.

Grants access to read revisions of your data store's entries.

Grants access to view configuration details for the authorized user's developer products.

Grants access to edit the authorized user's developer products.

This allows viewing information about your universe's environments.

This allows editing of your universe's environments.

Grants access to view configuration details for the authorized user's game passes.

Grants access to edit the authorized user's game passes.

Grants access to view community forums information for your account.

Grants access to manage community forums information for your account.

This allows viewing information about your communities.

This allows you to manage community join requests and role updates of lower-ranked community members for your account.

Allows you to view an instance's property data.

Allows you to modify the property data of instances (currently only supports Scripts).

This allows viewing information about your inventory.

Grants access to manage your badges and spend Robux.

Grants access to update the authorized user's badges.

Grants access to manage your developer products.

Grants access to read information about the experiences you have notifications on for.

Grants access to turn on or off notifications for experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

Allows you to view the status, logs, and results of Luau execution tasks for the associated place.

Allows you to create new Luau execution tasks for the associated place.

Grants access to asynchronously flush all data structures in the universe.

Grants access to discard read items from the front of the queue.

Grants access to read items at the front of the queue.

Grants access to read your memory store items.

Grants access to create, update, and delete map items.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

(Deprecated) Grants access to read a list of entries in an ordered data store.

(Deprecated) Grants access to create a new entry in an ordered data store.

Grants access to list entries from an ordered data store.

Grants access to create entries in an ordered data store.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

This permission allows you to submit an evaluation job and view the job result.

Grants access to read about your subscription products.

This allows you to read thumbnail information on your behalf.

Grants the ability to read analytics alerts.

Grants the ability to create or modify analytics alerts.

Grants the ability to read game analytics.

Grants the ability to write resources related to game analytics.

Grants the ability to read place information.

Grants the ability to edit place information.

Grants access to publish new versions of experiences to Roblox.

This allows you to read thumbnails and thumbnail personalization settings for your experiences.

This allows you to upload and delete thumbnails and manage thumbnail personalization settings for your experiences.

Grants the ability to read experience information.

Grants access to edit the authorized user's experiences.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

This allows viewing notifications sent to your account.

Grants the ability to read the authorized user's premium and verified status.

This allows you to view the authorized user's social accounts.

Grants the ability to read a game's events.

This enables Single Sign-On functionality.

This grants access to read your profile information.