Assets API

Assets

https://apis.roblox.com/assets

Get Asset

GET /v1/assets

Parametreler

assetId object
Path
Gerekli
readMask string

Talep

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

Yanıt

Gerekli İzinler

  • Oku
  • asset:read

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Create Asset

POST /v1/assets

Parametreler

request object
FormData
Gerekli
fileContent string
FormData
Gerekli

Talep

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'

Yanıt

200 - OK
Returns the Operation ID for checking the creation status.
Şunu döndürür: object
path string
metadata object
done boolean
error object
response object

Gerekli İzinler

  • Oku
  • Yaz
  • asset:read
  • asset:write

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Update Asset

PATCH /v1/assets/{assetId}

Parametreler

request object
FormData
Gerekli
fileContent string
FormData
updateMask string

Talep

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

Yanıt

200 - OK
Returns the Operation ID for checking the update status / Returns the updated metadata fields.
Şunu döndürür: 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

Gerekli İzinler

  • Oku
  • Yaz
  • asset:read
  • asset:write

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Get Asset Version

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

Parametreler

assetId string
Path
Gerekli
versionNumber string
Path
Gerekli

Talep

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

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

Yanıt

Gerekli İzinler

  • Oku
  • asset:read

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

List Asset Versions

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

Parametreler

assetId string
Path
Gerekli
maxPageSize number
pageToken string

Talep

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

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

Yanıt

Gerekli İzinler

  • Oku
  • asset:read

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Rollback Asset Version

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

Parametreler

assetId string
Path
Gerekli
assetVersion string
FormData
Gerekli

Talep

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

Yanıt

Gerekli İzinler

  • Oku
  • Yaz
  • asset:read
  • asset:write

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Get Operation

GET /v1/operations/{operationId}

Talep

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

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

Yanıt

200 - OK
Şunu döndürür: object
path string
metadata object
done boolean
error object
response object

Gerekli İzinler

  • Oku
  • asset:read

Sınırlar

API Anahtarı başına: Her 60 saniyede IP adresi başına 60 talep

Nesneler

Şu nesneler kabul edilen veya döndürülen yükleri tanımlar. Bu nesnelerin ne zaman kullanıldığı hakkında daha fazla bilgi için tüm uç noktalara bak.

Any

Nitelikler

@type string

Asset

Nitelikler

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

Nitelikler

creator object
Gerekli
expectedPrice number

Creator

Nitelikler

userId number
groupId number

ModerationResult

Nitelikler

moderationState string

Operation

Nitelikler

path string
metadata object
done boolean
error object
response object

Preview

Nitelikler

asset string
altText string

Nitelikler

title string
uri string

Status

Nitelikler

code number
message string
details array<object>