Assets API

Assets

https://apis.roblox.com/assets

Get Asset

GET /v1/assets

パラメータ

assetId Asset
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 秒ごとに送信されます

Create Asset

POST /v1/assets

パラメータ

request Asset
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
Returns the Operation ID for checking the creation status.
以下を返す： object: Operation
path string
metadata Any
done boolean
error Status
response Any

必要な権限

  • 読み取り
  • 書き込み
  • asset:read
  • asset:write

限度

各APIキー：各IPアドレスにつき 60 回のリクエストが 60 秒ごとに送信されます

Update Asset

PATCH /v1/assets/{assetId}

パラメータ

request Asset
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.\"}]}"'

レスポンス

200 - OK
Returns the Operation ID for checking the update status / Returns the updated metadata fields.
以下を返す： object: Operation
path string
metadata Any
done boolean
error Status
response Any

必要な権限

  • 読み取り
  • 書き込み
  • asset:read
  • asset:write

限度

各APIキー：各IPアドレスにつき 60 回のリクエストが 60 秒ごとに送信されます

Get Asset Version

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 秒ごとに送信されます

List Asset Versions

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
  • asset:write

限度

各APIキー：各IPアドレスにつき 60 回のリクエストが 60 秒ごとに送信されます

Rollback Asset Version

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 Operation

GET /v1/operations/{operationId}

リクエスト

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

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

レスポンス

200 - OK
以下を返す： object: Operation
path string
metadata Any
done boolean
error Status
response Any

必要な権限

  • 読み取り
  • asset:read

限度

各APIキー：各IPアドレスにつき 60 回のリクエストが 60 秒ごとに送信されます

オブジェクト

以下のオブジェクトは、受け入れられたか返されたペイロードの説明です。これらのオブジェクトがいつ使用されるかについて詳しくは、各エンドポイントを参照してください。

Any

属性

@type string
必須

Asset

属性

assetType string
必須
assetId number
必須
creationContext CreationContext
必須
description string
必須
displayName string
必須
path string
必須
revisionId string
必須
revisionCreateTime string
必須
moderationResult ModerationResult
必須
icon string
必須
previews array<Preview>
必須

CreationContext

属性

creator Creator
必須
expectedPrice number
必須

Creator

属性

userId number
必須
groupId number
必須

ModerationResult

属性

moderationState string
必須

Operation

属性

path string
必須
metadata Any
必須
done boolean
必須
error Status
必須
response Any
必須

Preview

属性

asset string
必須
altText string
必須

Status

属性

code number
必須
message string
必須
details array<Any>
必須