資產 API
*此內容是使用 AI（Beta 測試版）翻譯，可能含有錯誤。若要以英文檢視此頁面，請按一下這裡。
您可以發送和接收以下請求和回應載具來在 Roblox 上創建資產。有關API使用的資訊，請參閱使用指南。
Assets
列出資產版本
列出特定素材的所有版本，並提供可選頁面分割。
參數
素材的獨特標識。
指定要包含在回應中的資產版本數量。有效值範圍為 1 到 50 (包括)。當未提供時，默認為 8。
用於頁面分割的代幣。值從以前的請求中獲得，可用於取回資產版本的下一頁。
請求
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \
--header 'x-api-key: {apiKey}'回應
需要權限
呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。
限制
每個 API 金鑰：每個 IP 位址每 60 秒 100 個請求
撤回資產版本
將資產滾回到特定的舊版本。
在表單資料中提供資產版本路徑。
參數
素材的獨特標識。
請求
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}\"}'回應
需要權限
呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。
限制
每個 API 金鑰：每個 IP 位址每 60 秒 100 個請求
創建資產
請求
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'回應
需要權限
呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。
限制
每個 API 金鑰：每個 IP 位址每 60 秒 60 個請求
取得資產
取回特定資產內容和元數據。
參數
素材的獨特標識。
要檢索的資產元數據欄位，包括說明、顯示名稱、圖示、社交鏈接和預覽。例如：description%2CdisplayName、previews%2CtwitchSocialLink。
請求
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \
--header 'x-api-key: {apiKey}'curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \
--header 'x-api-key: {apiKey}'回應
需要權限
呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。
限制
每個 API 金鑰：每個 IP 位址每 60 秒 60 個請求
更新資產
參數
素材的獨特標識。
需要更新的資產元數據欄位，包括說明、顯示名稱、圖示和預覽。例如：description%2CdisplayName、previews%2CtwitchSocialLink。
請求
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}\""'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}\"'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.\"}]}"'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\"}}"'回應
需要權限
呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。
限制
每個 API 金鑰：每個 IP 位址每 60 秒 60 個請求
取得資產版本
使用資產 ID 和版本號擷取特定資產版本。
參數
素材的獨特標識。
版本號碼。
請求
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \
--header 'x-api-key: {apiKey}'回應
需要權限
呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。
限制
每個 API 金鑰：每個 IP 位址每 60 秒 100 個請求
歸檔資產
檔案資產。已存檔的資產從網站消失，不再能在 Roblox 體驗中使用或可見，但您可以 恢復 它們。
參數
素材的獨特標識。
請求
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'回應
需要權限
呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。
限制
每個 API 金鑰：每個 IP 位址每 60 秒 100 個請求
恢復資產
恢復已歸檔的資素材。
參數
素材的獨特標識。
請求
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'回應
需要權限
呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。
限制
每個 API 金鑰：每個 IP 位址每 60 秒 100 個請求
獲得操作
使用返回的操作ID獲得資產創建或更新的結果。需要 閱讀 對 API 鑰匙許可和 素材：閱讀 對 OAuth 2.0 應用程式。
參數
操作的獨特標識。
請求
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'回應
需要權限
呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。
限制
每個 API 金鑰：每個 IP 位址每 60 秒 100 個請求
物件
以下物件描述被接受或退回的負載。若要獲得更多關於物件使用時機的資訊，請查看個別終點。
Any
包含一個隨機serialize的訊息，以及一個 @type 描述Serialization訊息類型的方塊。
特性
序列化訊息的類型。
Asset
代表一個資素材。
特性
素材的獨一標識。對於 更新資產 必須。
資產類輸入。只能是 Audio , Decal 或 Model 。需要用於 創建資產 。
不屬於資產內容的創建上下文，例如元數據和創作者資訊。需要用於 創建資產 。
素材的說明。限於 1000 個字符。對於 創建資產 必須。
素材的顯示名稱。對於 創建資產 必須。
圖示的資源路徑。
素材的審核結果。
素材的返回資源路徑。格式：assets/{assetId}。例如：assets/2205400862。
預覽列表，每個包含一個資產路徑和替代文字。預覽必須是 圖像 資產。
當前版本的創建時間戳。
素材的修訂ID。等於 versionNumber 。每次資產的變更都會自動提交新版本。格式是整數字串。例如：1。
素材的社交媒體鏈接。每個素材最多三個。對象名稱可以是任何： > > > > > > > > > > > > > > > 對於語法，請參閱更新資產下的樣本請求。
資產是否已啟用或已歸檔。未指定的資產不會被使用。
AssetVersion
一個資產版本。
特性
不屬於資產內容的創建上下文，例如元數據和創作者資訊。需要用於 創建資產 。
素材的審核結果。
資產版本返回的資源路徑格式。例如：assets/{assetId}/versions/{version}。例如：assets/2205400862/versions/1。
CreationContext
不屬於資產內容的創建上下文，例如元數據和創作者資訊。需要用於 創建資產 。
特性
代表一個創作者。
在 Robux 中預期的資產上傳費用。當實際價格超出預期時，操作會以 400 錯誤失敗。
Creator
代表一個創作者。
特性
群組ID。如果資產屬於群組所有者，則必須使用。
創作者的使用者ID。如果資產是個人所有的話，必須使用。
ModerationResult
素材的審核結果。
特性
素材的審核狀態。可以是 Reviewing , Rejected 或 Approved 。
Operation
這個資源代表一個長時間運行的操作，是網路 API 呼叫的結果。
特性
如果 false , 操作仍在進行中。如果 true , 操作已完成。
說明錯誤狀態的邏輯錯誤模型。
包含一個隨機serialize的訊息，以及一個 @type 描述Serialization訊息類型的方塊。
伺服器指定的資源路徑。默認格式為 operations/{operation_id} 。
包含一個隨機serialize的訊息，以及一個 @type 描述Serialization訊息類型的方塊。
Preview
資產預覽。
特性
預覽資產的替代文字。
預览資產路徑。
SocialLink
素材的社交媒體鏈接。每個素材最多三個。對象名稱可以是任何： > > > > > > > > > > > > > > > 對於語法，請參閱更新資產下的樣本請求。
特性
社交媒體綁定接的可選標題。在創作者中心未使用。
社交媒體綁定接的 URI。必須符合綁定接類型的預期格式。例如，twitchSocialLink 對象的標題必須為格式 https://twitch.tv/your-channel 。
State
資產是否已啟用或已歸檔。未指定的資產不會被使用。
特性
Status
說明錯誤狀態的邏輯錯誤模型。
特性
HTTP 狀態碼。
一個列表包含錯誤細節的訊息。
錯誤訊息。