Assets API

Assets

https://apis.roblox.com/assets

Get Asset

GET /v1/assets

พารามิเตอร์

assetId object
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: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

Create Asset

POST /v1/assets

พารามิเตอร์

request object
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
path string
metadata object
done boolean
error object
response object

สิทธิ์ที่ต้องมี

  • อ่าน
  • เขียน
  • asset:read
  • asset:write

การจำกัด

ต่อคีย์ API: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

Update Asset

PATCH /v1/assets/{assetId}

พารามิเตอร์

request object
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

การตอบกลับ

200 - OK
Returns the Operation ID for checking the update status / Returns the updated metadata fields.
ส่งคืน 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

สิทธิ์ที่ต้องมี

  • อ่าน
  • เขียน
  • asset:read
  • asset:write

การจำกัด

ต่อคีย์ API: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

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: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

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

การจำกัด

ต่อคีย์ API: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

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: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

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
path string
metadata object
done boolean
error object
response object

สิทธิ์ที่ต้องมี

  • อ่าน
  • asset:read

การจำกัด

ต่อคีย์ API: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

วัตถุ

วัตถุต่อไปนี้ใช้บรรยายเพย์โหลดที่ยอมรับหรือส่งคืน ดูข้อมูลเพิ่มเติมว่าจะใช้วัตถุเหล่านี้ตอนไหนที่ Endpoint แต่ละจุด

Any

คุณลักษณะ

@type string

Asset

คุณลักษณะ

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

คุณลักษณะ

creator object
จำเป็นต้องมี
expectedPrice number

Creator

คุณลักษณะ

userId number
groupId number

ModerationResult

คุณลักษณะ

moderationState string

Operation

คุณลักษณะ

path string
metadata object
done boolean
error object
response object

Preview

คุณลักษณะ

asset string
altText string

คุณลักษณะ

title string
uri string

Status

คุณลักษณะ

code number
message string
details array<object>