Instance attributes allow you to customize instances with your own data.

Supported Types

Studio Usage

Scripting

Creating/Modifying Attributes

Getting Attribute Values

Deleting Attributes

Detecting Attribute Changes

Instance Attributes

Overview

Guides

Tutorials

Reference

Resources

Design

Engine

Avatar

Cloud

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

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

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

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

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

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This allows viewing information about your groups.

This allows you to manage group join requests for your account.

This allows viewing information about your inventory.

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

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

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

This allows you to view a user's social accounts.

This enables Single Sign-On functionality

This grants access to read your profile information

Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

Learn how to create successful content on Roblox with comprehensive guides, code samples, reference, and tutorials.


{pageTitle} | {SiteName}

title

Unable to add to inventory

The code sample {title} has been added to your Inventory.

Version {versionNumber} includes general performance improvements and bug fixes. Check our other release notes for status on specific improvements and bugs.

Please don't include private or personal information. Maximum {maxDescriptionLength} words.

Minimum {minDescriptionLength} words required in the description.

Release Notes for Roblox Studio Version {versionNumber}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.