资产 API

*此内容使用人工智能（Beta）翻译，可能包含错误。若要查看英文页面，请点按此处。

Assets

https://apis.roblox.com/assets

列表资产版本

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

参数

assetId string

Path

必填

maxPageSize number

pageToken string

请求

List Asset Versions

curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \
--header 'x-api-key: {apiKey}'

答复

其他状态码

必要权限

读取

asset:read

限制

每个 API 密钥：每个 IP 地址每 60 秒有 60 次请求

滚回资产版本

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

参数

assetId string

Path

必填

assetVersion string

FormData

必填

请求

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}\"}'

答复

其他状态码

必要权限

读取
写入

asset:read
asset:write

限制

每个 API 密钥：每个 IP 地址每 60 秒有 60 次请求

获取资产

GET /v1/assets

参数

assetId

Path

必填

readMask string

请求

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}'

答复

其他状态码

必要权限

读取

asset:read

限制

每个 API 密钥：每个 IP 地址每 60 秒有 60 次请求

创建资产

POST /v1/assets

参数

request

FormData

必填

fileContent string

FormData

必填

请求

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'

答复

200 - OK

返回操作ID以检查创建状态。

返回： object

done boolean

error object

metadata object

path string

response object

其他状态码

必要权限

读取
写入

asset:read
asset:write

限制

每个 API 密钥：每个 IP 地址每 60 秒有 60 次请求

更新资产

PATCH /v1/assets/{assetId}

参数

request

FormData

必填

fileContent string

FormData

updateMask string

请求

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

curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=twitchSocialLink%2CgithubSocialLink' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": \"{assetId}\", \"twitchSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://twitch.tv/your-channel\"}, \"githubSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://github.com/your-repo\"}}"'

答复

200 - OK

返回操作 ID 检查更新状态/返回更新的数据字段。

返回： object

application/json

{\"previews\": [\n    {\"asset\": \"assets/123\", \"altText\": \"preview 1\"},\n    {\"asset\": \"assets/456\", \"altText\": \"preview 2\"}\n]}

done boolean

error object

metadata object

path string

response object

其他状态码

必要权限

读取
写入

asset:read
asset:write

限制

每个 API 密钥：每个 IP 地址每 60 秒有 60 次请求

获取资产版本

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

参数

assetId string

Path

必填

versionNumber string

Path

必填

请求

Get Asset Version

curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \
--header 'x-api-key: {apiKey}'

答复

其他状态码

必要权限

读取

asset:read

限制

每个 API 密钥：每个 IP 地址每 60 秒有 60 次请求

获取操作

GET /v1/operations/{operationId}

请求

Get Operation

curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'

答复

200 - OK

返回： object

done boolean

error object

metadata object

path string

response object

其他状态码

必要权限

读取

asset:read

限制

每个 API 密钥：每个 IP 地址每 60 秒有 60 次请求

对象

下列对象描述了接受或返回的有效载荷。请参阅每个单独的端点，以了解更多关于这些对象用途的信息。

Any

属性

@type string

Asset

属性

assetId number

assetType string

creationContext object

description string

displayName string

icon string

moderationResult object

path string

previews array<object>

revisionCreateTime string

revisionId string

socialLink object

CreationContext

属性

creator object

必填

expectedPrice number

Creator

属性

groupId number

userId number

ModerationResult

属性

moderationState string

Operation

属性

done boolean

error object

metadata object

path string

response object

Preview

属性

altText string

asset string

SocialLink

属性

title string

uri string

Status

属性

code number

details array<object>

message string