Assets API

Assets

https://apis.roblox.com/assets

Get Asset

GET /v1/assets

Tham Số

assetId object
Path
Bắt Buộc
readMask string

Yêu Cầu

Get Asset without readMask
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \

--header 'x-api-key: {apiKey}'
Get Asset with readMask
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \

--header 'x-api-key: {apiKey}'

Phản Hồi

Quyền Cần Có

  • Đọc
  • asset:read

Giới Hạn

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

Create Asset

POST /v1/assets

Tham Số

request object
FormData
Bắt Buộc
fileContent string
FormData
Bắt Buộc

Yêu Cầu

Create Asset
curl --location --request POST 'https://apis.roblox.com/assets/v1/assets' \

--header 'x-api-key: {apiKey}' \

--form 'request="{ 

  \"assetType\": \"Model\",  

  \"displayName\": \"Name\", 

  \"description\": \"This is a description\", 

  \"creationContext\": { 

    \"creator\": { 

      \"userId\": \"${userId}\" 

    } 

  } 

}"' \

--form 'fileContent=@"/filepath/model.fbx";type=model/fbx'

Phản Hồi

200 - OK
Returns the Operation ID for checking the creation status.
Trả lại object
path string
metadata object
done boolean
error object
response object

Quyền Cần Có

  • Đọc
  • Ghi
  • asset:read
  • asset:write

Giới Hạn

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

Update Asset

PATCH /v1/assets/{assetId}

Tham Số

request object
FormData
Bắt Buộc
fileContent string
FormData
updateMask string

Yêu Cầu

Update Content Only and Create a New Version
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}' \

--header 'x-api-key: {apiKey}' \

--form 'request="{\"assetId\": {assetId} }"' \

--form 'fileContent="@\"{file-path}\""'
Update Content and Metadata
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=description%2CdisplayName' \

--header 'x-api-key: {apiKey}' \

--form 'request="{

    \"assetType\": \"{assetType}\",

    \"assetId\": {assetId},

    \"displayName\": \"{new display name}\",

    \"description\": \"{new description}\",    

    \"creationContext\": { 

        \"creator\": {

            \"userId\": {userId}

        },

        \"expectedPrice\":{expectedPrice}

    },

}"' \

--form 'fileContent=@\"{file-path}\"'
Update a List of Previews
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=previews' \

--header 'x-api-key: {apiKey}' \

--form 'request="{\"assetId\": \"{assetId}\", \"previews\": [{\"asset\": \"assets/123\", \"altText\": \"Your alt text.\"}]}"'
Update Social Links

Phản Hồi

200 - OK
Returns the Operation ID for checking the update status / Returns the updated metadata fields.
Trả lại object
application/json
{\"previews\": [\n    {\"asset\": \"assets/123\", \"altText\": \"preview 1\"},\n    {\"asset\": \"assets/456\", \"altText\": \"preview 2\"}\n]}
path string
metadata object
done boolean
error object
response object

Quyền Cần Có

  • Đọc
  • Ghi
  • asset:read
  • asset:write

Giới Hạn

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

Get Asset Version

GET /v1/assets/{assetId}/versions/{versionNumber}

Tham Số

assetId string
Path
Bắt Buộc
versionNumber string
Path
Bắt Buộc

Yêu Cầu

Get Asset Version
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \

--header 'x-api-key: {apiKey}'

Phản Hồi

Quyền Cần Có

  • Đọc
  • asset:read

Giới Hạn

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

List Asset Versions

GET /assets/v1/assets/{assetId}/versions

Tham Số

assetId string
Path
Bắt Buộc
maxPageSize number
pageToken string

Yêu Cầu

List Asset Versions
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \

--header 'x-api-key: {apiKey}'

Phản Hồi

Quyền Cần Có

  • Đọc
  • asset:read

Giới Hạn

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

Rollback Asset Version

POST /assets/v1/assets/{assetId}/versions:rollback

Tham Số

assetId string
Path
Bắt Buộc
assetVersion string
FormData
Bắt Buộc

Yêu Cầu

Rollback Asset Versions
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions:rollback' \

--header 'x-api-key: {apiKey}' \

--header 'Content-Type: application/json' \

--data '{\"assetVersion\":\"assets/{assetId}/versions/{versionNumber}\"}'

Phản Hồi

Quyền Cần Có

  • Đọc
  • Ghi
  • asset:read
  • asset:write

Giới Hạn

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

Get Operation

GET /v1/operations/{operationId}

Yêu Cầu

Get Operation
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \

--header 'x-api-key: {apiKey}'

Phản Hồi

200 - OK
Trả lại object
path string
metadata object
done boolean
error object
response object

Quyền Cần Có

  • Đọc
  • asset:read

Giới Hạn

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

Đối Tượng

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.

Any

Thuộc Tính

@type string

Asset

Thuộc Tính

assetType string
assetId number
creationContext object
description string
displayName string
path string
revisionId string
revisionCreateTime string
moderationResult object
icon string
previews array<object>
socialLink object

CreationContext

Thuộc Tính

creator object
Bắt Buộc
expectedPrice number

Creator

Thuộc Tính

userId number
groupId number

ModerationResult

Thuộc Tính

moderationState string

Operation

Thuộc Tính

path string
metadata object
done boolean
error object
response object

Preview

Thuộc Tính

asset string
altText string

Thuộc Tính

title string
uri string

Status

Thuộc Tính

code number
message string
details array<object>