Một khóa có thể cấu hình cho phép truy cập chi tiết đến các tài nguyên của Roblox. Xem https://create.roblox.com/docs/cloud/auth/api-keys để biết thêm thông tin.

x-api-key

Một cookie trình duyệt đại diện cho danh tính của người dùng Roblox. KHÔNG CHIA SẺ ĐIỀU NÀY. Việc chia sẻ này sẽ cho phép ai đó đăng nhập như bạn và đánh cắp Robux và vật phẩm của bạn. Chúng tôi không khuyên bạn nên sử dụng cookie để gọi các điểm cuối. Khi có thể, hãy sử dụng khóa API với tiêu đề x-api-key hoặc OAuth 2.0 thay vào đó để xác thực.

.ROBLOSECURITY

Xây dựng hoặc ủy quyền ứng dụng để truy cập tài nguyên Roblox. Xem https://create.roblox.com/docs/cloud/auth/oauth2-overview để biết thêm thông tin.

API Roblox. Xem https://create.roblox.com/docs/cloud/open-cloud để biết thêm chi tiết.

API Roblox

groupId

timeFrame

Tiền tệ chỉ có thể được lấy cho người dùng đã xác thực.

0: Quyền truy cập đã bị từ chối cho yêu cầu này.

Lấy tiền tệ cho người dùng đã xác thực.

exclusiveStartRequest

transactionType

userId

usedTypes

exclusiveStartCursor

itemPricingType

economy.roblox.com

Trải Nghiệm

Avatar

Tài Sản

Mẫu và dự án

API của công cụ

API đám mây nguồn mở

Studio

Phân Tích

Nền tảng

Hướng Dẫn

Chương trình của nhà sáng tạo

Giáo dục

Các khóa học

Học tập

Phương pháp này không đồng bộ và trả về một "Hoạt Động" cho biết trạng thái hiện tại của hoạt động. Phương pháp chứa một đường dẫn điểm cuối mà bạn có thể thăm dò để nhận về phản hồi thực tế và siêu dữ liệu hiện hành. Xem [tài liệu] ({longRunningOperationsLink}) về các hoạt động kéo dài để biết thêm thông tin.
            
Các phần dưới đây mô tả những phản hồi và siêu dữ liệu có được khi một hoạt động hoàn thành.

Các đầu cuối beta đã sẵn sàng cho việc sử dụng công khai. Có thể xuất hiện những thay đổi bất ngờ, nhưng trường hợp này rất hiếm.

Các trang tài liệu Open Cloud này sẽ bị gỡ bỏ vào ngày 31 tháng 3 năm 2026. Tại thời điểm đó, hệ thống sẽ tự động chuyển hướng bạn đến trang tài liệu Open Cloud mới. {linkStart}Tìm hiểu thêm{linkEnd}

Các trang Open Cloud cũ này sẽ bị gỡ bỏ và tự động chuyển hướng vào ngày 31 tháng 3 năm 2026. {linkStart}Tìm hiểu thêm{linkEnd}

Các điểm cuối thử nghiệm đã sẵn sàng để sử dụng công khai, nhưng đôi khi có thể gặp thay đổi gây mất tương thích khi hợp đồng API được hoàn thiện.

Có thể dùng khóa API để chạy lệnh gọi điểm cuối này thông qua {httpServiceLinkStart}HttpService{httpServiceLinkEnd}.

Trường này có thể được đặt khi tạo tài nguyên, nhưng không thể được sửa đổi bởi các yêu cầu tiếp theo.

Các trường này có thể được đặt khi tạo tài nguyên, nhưng không thể được sửa đổi bởi các yêu cầu tiếp theo.

Trường này có thể được cung cấp trong các yêu cầu, nhưng sẽ không bao giờ được đưa vào các phản hồi.

Phương thức xác thực cũ. Luôn ưu tiên sử dụng API Key hoặc OAuth 2.0 khi có thể.

Mỗi Khóa API: {maxInPeriod} yêu cầu mỗi {periodInSeconds} giây cho mỗi Địa Chỉ IP

Không yêu cầu xác thực khi gọi. Thông thường có giới hạn tần suất thấp hơn đáng kể. Luôn ưu tiên sử dụng API Key hoặc OAuth 2.0 khi có thể.

Với mỗi nhóm, chỉ cần cung cấp một trong các trường sau trong lược đồ, các trường còn lại có thể bỏ qua.

Bạn có thể chọn sử dụng lại bất cứ lúc nào. {linkStart}Gửi ý kiến phản hồi.{linkEnd}

Bạn đang xem tài liệu cũ. {linkStart}Gửi ý kiến phản hồi.{linkEnd}

Bạn có thể ngừng sử dụng bất cứ lúc nào và sẽ được chuyển hướng về các trang tham chiếu cũ. {linkStart}Gửi phản hồi.{linkEnd}

Bạn đang xem tài liệu đã được cải tiến. {linkStart}Gửi ý kiến phản hồi.{linkEnd}

Trường này có thể được đặt thành các phản hồi, nhưng sẽ bị bỏ qua trong các yêu cầu.

Lưu ý: Trong các giai đoạn cao điểm, giới hạn về tần suất có thể thấp hơn. Một số điểm cuối có giới hạn tần suất bổ sung. [Tìm hiểu thêm về giới hạn tần suất]({link}).

{limit} yêu cầu mỗi ngày cho tất cả khóa API của một người dùng hoặc nhóm

{limit} yêu cầu mỗi giờ cho tất cả khóa API của một người dùng hoặc nhóm

{limit} yêu cầu mỗi phút cho tất cả khóa API của một người dùng hoặc nhóm

{limit} yêu cầu mỗi giây cho tất cả khóa API của một người dùng hoặc nhóm

{limit} yêu cầu mỗi phút đối với mỗi người sở hữu khóa API

{limit} yêu cầu mỗi ngày cho mỗi người dùng ứng dụng

{limit} yêu cầu mỗi giờ cho mỗi người dùng ứng dụng

{limit} yêu cầu mỗi phút cho mỗi người dùng ứng dụng

{limit} yêu cầu mỗi giây cho mỗi người dùng ứng dụng

{limit} yêu cầu mỗi giây đối với mỗi người sở hữu khóa API

Các phạm vi sẽ kiểm soát những quyền được cấp cho thông tin đăng nhập của bạn. Bạn chỉ có thể sử dụng thông tin đăng nhập để truy cập các điểm cuối mà phạm vi bạn chọn có hỗ trợ.

Các điểm cuối ổn định đã sẵn sàng cho môi trường sản xuất và hầu như sẽ không gặp thay đổi gây mất tương thích trong suốt vòng đời của chúng.

Mục tiêu này cho phép bạn giới hạn quyền truy cập của khóa mã trong phạm vi {requiredParts} được chọn

Mục tiêu này cho phép bạn giới hạn quyền truy cập của khóa mã trong phạm vi {requiredParts} và {optionalParts} được chọn

Loại mục tiêu được dùng để giới hạn những tài nguyên mà bạn có quyền sử dụng theo thông tin đăng nhập của mình. Chỉ có thể thao tác với những tài nguyên được chọn, ngay cả khi tài khoản của bạn được phép sử dụng những tài nguyên khác. Một số phạm vi không áp dụng theo bộ phận mục tiêu. Trong trường hợp này, bạn có thể thao tác với mọi tài nguyên liên quan.

Không cần chọn Phần cấp cao nhất của vũ trụ cho các Khóa API do người dùng sở hữu. Trong trường hợp này, Khóa API của bạn sẽ có quyền truy cập vào tất cả các trải nghiệm do bạn sở hữu với tư cách người dùng và các trải nghiệm thuộc nhóm mà bạn có quyền nhóm tương ứng.

Tính năng Dùng thử chưa hỗ trợ các điểm cuối yêu cầu khóa API hoặc xác thực OAuth 2.0

Để đảm bảo an toàn, tính năng xác thực bằng cookie đã bị vô hiệu hóa cho các hoạt động có rủi ro cao.

Các điểm cuối có rủi ro nghiêm trọng là cực kỳ nhạy cảm và tính năng Dùng thử đã bị vô hiệu hóa để đảm bảo an toàn

Lưu ý: Các tiêu đề xác thực không có trong mẫu mã này. Bạn có thể cần thêm tiêu đề xác thực để lệnh này có hiệu lực.

Đây là một điểm cuối có rủi ro cao, có thể sửa đổi hoặc xóa dữ liệu quan trọng. Hãy hết sức thận trọng khi kiểm thử.

Điểm cuối API này được phân loại là RỦI RO CAO và có thể ảnh hưởng đến dữ liệu trực tiếp hoặc tài khoản người dùng.

Các yêu cầu đã xác thực đến API rủi ro cao có thể tạo ra những thay đổi không thể hoàn tác. Vui lòng xem xét kỹ các tham số yêu cầu của bạn trước khi tiếp tục.

Vui lòng đăng nhập để sử dụng xác thực cookie

Đây là một điểm cuối có rủi ro thấp dùng để truy xuất dữ liệu, nhìn chung là an toàn để kiểm thử.

Đây là điểm cuối có rủi ro trung bình dùng để sửa đổi dữ liệu. Hãy kiểm thử cẩn thận bằng các tài khoản không quan trọng, vì các thay đổi có thể được áp dụng vĩnh viễn.

Để đảm bảo an toàn cho tài khoản của bạn, tuyệt đối không dán văn bản từ các nguồn khác vào đây hoặc gửi thông tin từ trang này cho người khác.

Bạn sắp kiểm thử các điểm cuối API trực tiếp bằng thông tin xác thực tài khoản thực của mình.

Hãy chỉ tiếp tục nếu bạn hiểu rõ hệ quả của những lệnh gọi API mà bạn sắp thực hiện. Đừng quên xem kỹ tài liệu API trước khi kiểm thử.

Các lệnh gọi API sẽ được thực hiện bằng phiên đã xác thực của bạn

Đây là các lệnh gọi API thực có thể ảnh hưởng đến tài khoản hoặc dữ liệu của bạn

Giới hạn tốc độ và các hạn chế khác về API sẽ được áp dụng

Một số thao tác có thể khiến dữ liệu bị sửa đổi hoặc xóa

Điểm cuối này đã được thay thế bằng các đề xuất sau:

Cần có các phạm vi sau để gọi điểm cuối này. Để biết thêm
thông tin về cách tạo khóa thích hợp, hãy xem [Quản lý khóa API]({apiKeyReferenceDocLink}).

Để biết thêm thông tin về cách tạo khóa, hãy xem [Quản lý khóa API]({apiKeyReferenceDocLink}).

Các điểm cuối sau đây có trong đường dẫn liên quan đến URL cơ sở.

Chuỗi này được định dạng là [Mặt nạ trường](/cloud/reference/types#timestamp).

Giá trị JSON có thể là `null`, `boolean`, `string`, `number`, `array` hoặc `object`.

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem [Đăng ký và đánh giá ứng dụng]({oauth2ReferenceDocLink}).

Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem [Đăng ký và xem xét ứng dụng]({oauth2ReferenceDocLink}).

Các đối tượng sau đây mô tả payload được chấp nhận hoặc bị trả về. Xem từng điểm cuối để biết thêm thông tin về thời điểm sử dụng các đối tượng này.

Cần có các phạm vi sau để gọi điểm cuối này.

Đường dẫn của tài nguyên

Chuỗi này được định dạng là [Dấu thời gian](/cloud/reference/types#timestamp).

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem [Đăng Ký và Đánh Giá Ứng Dụng]({oauth2ReferenceDocLink}).

Không khuyến khích

Bạn đang xem tài liệu tham khảo Open Cloud phiên bản mới.

Bạn đã chọn không sử dụng tài liệu tham khảo Open Cloud mới.

Không có mô tả nào được cung cấp.

Xem tài khoản chi trả quảng cáo của bạn.

Xem chiến dịch quảng cáo của bạn và hiệu suất của các chiến dịch đó.

Tạo, cập nhật và quản lý chiến dịch quảng cáo của bạn.

Điều này cho phép bạn xem thông tin về tài sản của mình.

Điều này cho phép bạn tải lên và cập nhật tài sản vào Roblox.

Quyền này cho phép xem quyền đối với tài sản cho các chủ thể (bao gồm nhóm và trải nghiệm) cũng như các tài sản mà tài khoản của bạn có quyền truy cập.

Điều này giúp bạn có thể cấp quyền đối với tài sản cho bất kỳ chủ thể nào (bao gồm nhóm và trải nghiệm) để sử dụng những tài sản mà tài khoản của bạn đang quản lý.

Quyền này cho phép bạn xem trạng thái và kết quả của các tác vụ tự động thiết lập avatar thay mặt cho bạn.

Quyền này cho phép bạn tạo và quản lý các tác vụ tự động thiết lập avatar thay mặt cho bạn.

Cấp khả năng cập nhật huy hiệu mà người dùng sở hữu.

Điều này cho phép bạn xem thông tin về vật phẩm thương mại của mình.

Thao tác này cho phép thay đổi các vật phẩm thương mại đã đồng bộ của bạn.

Việc này cho phép xem thông tin về người quen là người bán thương mại của bạn.

Điều này cho phép bạn chỉnh sửa các kết nối người bán thương mại.

Điều này cho phép bạn xem thông tin về các sản phẩm trong Cửa Hàng Nhà Sáng Tạo của bạn.

Điều này cho phép bạn sửa đổi thông tin về các sản phẩm trong Cửa Hàng Nhà Sáng Tạo của bạn.

Điều này cho phép bạn xem thông tin về các mục đã lưu trong Cửa hàng nhà sáng tạo của mình.

Điều này cho phép bạn sửa đổi thông tin về các mục đã lưu trong Cửa hàng nhà sáng tạo của mình.

Cấp quyền tạo kho dữ liệu thay mặt cho bạn.

Hãy cấp quyền xóa các kho dữ liệu thay mặt cho bạn.

Cấp quyền đọc danh sách kho dữ liệu.

Cấp quyền tạo ảnh chụp nhanh cho các kho dữ liệu của bạn.

Cấp quyền tạo mục trong kho dữ liệu của bạn.

Cấp quyền đánh dấu mục được chỉ định để xóa.

Cấp quyền liệt kê các bản sửa đổi bản ghi trong kho dữ liệu của bạn.

Cấp quyền đọc mục được chỉ định trong kho dữ liệu của bạn.

Cấp quyền cập nhật giá trị, thuộc tính và người dùng của một mục nhập.

Cấp quyền xóa các bản sửa đổi bản ghi trong kho dữ liệu của bạn.

Cấp quyền đọc các bản sửa đổi bản ghi trong kho dữ liệu của bạn.

Cấp quyền truy cập để xem chi tiết cấu hình cho các sản phẩm nhà phát triển của người dùng được ủy quyền.

Cấp quyền chỉnh sửa các sản phẩm nhà phát triển của người dùng được ủy quyền.

Tính năng này cho phép xem thông tin về môi trường trong vũ trụ của bạn.

Tính năng này cho phép chỉnh sửa môi trường trong vũ trụ của bạn.

Cấp quyền xem chi tiết cấu hình cho các vé trò chơi của người dùng được ủy quyền.

Cấp quyền chỉnh sửa vé trò chơi của người dùng được ủy quyền.

Hãy cấp quyền truy cập để xem thông tin trên diễn đàn cộng đồng của tài khoản bạn.

Cấp quyền truy cập để quản lý thông tin trên diễn đàn cộng đồng cho tài khoản của bạn.

Điều này cho phép bạn xem thông tin về cộng đồng của mình.

Điều này cho phép bạn quản lý các yêu cầu tham gia cộng đồng và cập nhật vai trò của thành viên cộng đồng bậc thấp cho tài khoản của bạn.

Cho phép bạn xem dữ liệu thuộc tính của một trường hợp.

Cho phép bạn sửa đổi dữ liệu thuộc tính của các đối tượng (hiện chỉ hỗ trợ Tập lệnh).

Điều này cho phép bạn xem thông tin về kho của mình.

Cấp quyền quản lý tài sản của người dùng.

Cấp quyền truy cập để quản lý huy hiệu của bạn.

Cấp quyền để quản lý huy hiệu của bạn và chi tiêu robux.

Cấp quyền cập nhật huy hiệu của người dùng được ủy quyền.

Cấp quyền quản lý các sản phẩm phát triển của bạn.

Cho phép truy cập để đọc thông tin về các trải nghiệm mà bạn đã bật thông báo.

Cho phép thay mặt bạn bật hoặc tắt thông báo cho trải nghiệm.

Cấp quyền truy cập để quản lý vé của bạn.

Cấp quyền truy cập để quản lý các cộng đồng của bạn.

Cấp quyền để đọc thông tin cộng đồng.

Cấp quyền để đọc và ghi các bảng bản địa hóa của bạn

Cấp quyền truy cập để quản lý hoạt động cộng tác đội cho tất cả các trải nghiệm của bạn.

Cấp quyền truy cập để quản lý các trải nghiệm của bạn và một số thông tin cụ thể gắn liền với các trải nghiệm đó (ví dụ: thông tin bản địa hóa).

Cấp quyền để đọc thông tin bản địa hóa của các trải nghiệm của bạn.

Cấp quyền để sửa đổi các tùy chọn bản địa hóa trải nghiệm của bạn.

Cấp quyền truy cập để quản lý tài khoản người dùng của bạn.

Cấp quyền để sửa đổi các tùy chọn bản địa hóa của người dùng.

Cho phép bạn xem trạng thái, nhật ký và kết quả của các tác vụ thực thi Luau cho địa điểm được liên kết.

Cho phép bạn tạo các tác vụ thực thi Luau mới cho địa điểm được liên kết.

Cấp quyền xóa không đồng bộ tất cả các cấu trúc dữ liệu trong vũ trụ.

Cấp quyền tạo mục mới trong hàng chờ.

Cấp quyền loại bỏ các mục đã đọc khỏi đầu hàng chờ.

Cấp quyền đọc các mục ở đầu hàng chờ.

Cấp quyền đọc các mục trong kho lưu trữ bộ nhớ của bạn.

Cấp quyền đọc các mục trên bản đồ.

Cấp quyền tạo, cập nhật và xóa các mục trên bản đồ.

Điều này cho phép bạn đăng tải tin nhắn thay mặt cho người dùng.

Điều này cho phép gửi các thông báo từ trải nghiệm của bạn đến người dùng.

(Lỗi thời) Cấp quyền đọc danh sách các mục trong một kho dữ liệu đã sắp xếp.

(Lỗi thời) Cấp quyền tạo một mục mới trong kho dữ liệu đã sắp xếp.

Cấp quyền liệt kê các mục từ một kho dữ liệu đã sắp xếp.

Cấp quyền tạo các mục trong một kho dữ liệu đã sắp xếp.

Điều này cho phép bạn liệt kê mã liên quan đến trải nghiệm của bạn.

Điều này cho phép bạn tạo và cập nhật mã liên quan đến trải nghiệm của bạn.

Quyền này cho phép bạn gửi một tác vụ đánh giá và xem kết quả của tác vụ.

Cấp quyền để đọc về các trang bị đặc quyền của bạn.

Quyền này cho phép bạn đọc thông tin hình nhỏ thay mặt cho bạn.

Cấp quyền đọc dữ liệu phân tích trò chơi.

Cấp khả năng đọc thông tin địa điểm.

Cấp khả năng chỉnh sửa thông tin địa điểm.

Cấp quyền đăng phiên bản mới của trải nghiệm lên Roblox.

Cấp khả năng đọc thông tin trải nghiệm.

Cấp quyền chỉnh sửa trải nghiệm của người dùng được ủy quyền.

Cho phép bạn xem các hạn chế của người dùng trong trải nghiệm.

Cho phép bạn chỉnh sửa các hạn chế người dùng trong trải nghiệm.

Quyền này cho phép xem các thông báo được gửi đến tài khoản của bạn.

Cho phép đọc trạng thái premium và trạng thái đã xác thực của người dùng được ủy quyền.

Quyền này cho phép bạn xem các tài khoản xã hội của người dùng được ủy quyền.

Điều này cho phép kích hoạt chức năng Đăng Nhập Một Lần.

Điều này cho phép người dùng đọc thông tin hồ sơ của bạn.

Hàm này sẽ trả về kết quả ngay lập tức nếu có thể, nhưng cũng có khả năng tạm dừng luồng đã gọi hàm cho đến khi hàm có giá trị để trả về.

Tìm hiểu thêm về {linkStart}các khả năng{linkEnd}.

{nameStart}tên{nameEnd} không còn được hỗ trợ hoặc duy trì bởi Roblox.

Roblox không còn hỗ trợ và duy trì điểm cuối này.

Phép toán này không còn được hỗ trợ hoặc duy trì bởi Roblox.

Thành phần này không xuất hiện trong trình duyệt đối tượng và không dành cho mục đích sử dụng rộng rãi.

Chỉ có thể truy cập thành phần thông qua thanh lệnh. Việc sử dụng thành phần này trong kịch bản sẽ gây ra lỗi.

Hàm này không thể tạm dừng luồng Lua đã gọi hàm.

Việc cố gắng truy cập thành phần này trong kịch bản sẽ gây ra lỗi. Tuy nhiên, bạn có thể truy cập thành phần này từ cửa sổ thuộc tính của Roblox Studio.

Thành phần này không xuất hiện trong Trình duyệt Đối tượng của Roblox Studio.

Bạn không thể tạo một phiên bản của lớp này với hàm khởi tạo Instance.new.

Roblox không sao chép thành phần này qua ranh giới máy chủ - máy khách.

Mã Lua không thể truy cập thành phần này. Bạn có thể thay đổi giá trị của nó từ cửa sổ thuộc tính trong Roblox Studio.

Thành viên này có thể truy cập từ các nhiệm vụ thực thi OpenCloud Luau.

Hành vi sao chép của đối tượng này phụ thuộc vào người chơi sở hữu nó.

Có thể truy cập thành phần thông qua thanh lệnh và plugin. Việc sử dụng thành phần này trong tập lệnh sẽ gây ra lỗi.

Thành phần này ở dạng chỉ đọc. Việc cố ghi vào thành phần này sẽ gây ra lỗi.

Thuộc tính này ở dạng chỉ đọc và có thể đọc an toàn trên các luồng không đồng bộ. Việc cố gắng ghi vào thuộc tính này sẽ gây ra lỗi.

Hiện có các điểm cuối thay thế khác tối ưu hơn điểm cuối này.

Chỉ có thể truy cập thành phần này trong CoreScripts.

Chỉ Roblox CoreScripts mới có thể truy cập thành phần này, và Người Chơi không thể truy cập được.

Bạn có thể đọc và ghi vào thuộc tính này một cách an toàn từ nhiều luồng.

Lớp này là một singleton hàng đầu. Hãy lấy một phiên bản của lớp này bằng hàm GetService.

Có thể truy cập thông qua các hàm gọi lại được liên kết với {link1Start}RunService:BindToSimulation(){link1End}. Có tham gia vào quá trình hoàn tác. Xem {link2Start}quyền hạn máy chủ{link2End}.

Nhiều luồng có thể ghi thuộc tính này, vì vậy việc đọc từ các luồng không đồng bộ sẽ là một việc không an toàn.

Hàm này sẽ tạm dừng luồng Lua đã gọi hàm cho đến khi hàm này trả về một kết quả. Tuy nhiên, việc tạm dừng này không ảnh hưởng đến các kịch bản khác đang chạy.

economy.roblox.com

Groups

Localization

Universes

Users