Assets API

Assets

https://apis.roblox.com/assets

Get Asset

GET /v1/assets

Parametry

assetId object
Path
Wymagane
readMask string

Żądanie

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

Odpowiedź:

Wymagane uprawnienia

  • Odczyt
  • asset:read

Limity

Na klucz API: żądanie 60 co 60 s na adres IP

Create Asset

POST /v1/assets

Parametry

request object
FormData
Wymagane
fileContent string
FormData
Wymagane

Żądanie

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'

Odpowiedź:

200 - OK
Returns the Operation ID for checking the creation status.
Zwraca: object
path string
metadata object
done boolean
error object
response object

Wymagane uprawnienia

  • Odczyt
  • Zapis
  • asset:read
  • asset:write

Limity

Na klucz API: żądanie 60 co 60 s na adres IP

Update Asset

PATCH /v1/assets/{assetId}

Parametry

request object
FormData
Wymagane
fileContent string
FormData
updateMask string

Żądanie

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

Odpowiedź:

200 - OK
Returns the Operation ID for checking the update status / Returns the updated metadata fields.
Zwraca: 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

Wymagane uprawnienia

  • Odczyt
  • Zapis
  • asset:read
  • asset:write

Limity

Na klucz API: żądanie 60 co 60 s na adres IP

Get Asset Version

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

Parametry

assetId string
Path
Wymagane
versionNumber string
Path
Wymagane

Żądanie

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

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

Odpowiedź:

Wymagane uprawnienia

  • Odczyt
  • asset:read

Limity

Na klucz API: żądanie 60 co 60 s na adres IP

List Asset Versions

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

Parametry

assetId string
Path
Wymagane
maxPageSize number
pageToken string

Żądanie

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

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

Odpowiedź:

Wymagane uprawnienia

  • Odczyt
  • asset:read

Limity

Na klucz API: żądanie 60 co 60 s na adres IP

Rollback Asset Version

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

Parametry

assetId string
Path
Wymagane
assetVersion string
FormData
Wymagane

Żądanie

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

Odpowiedź:

Wymagane uprawnienia

  • Odczyt
  • Zapis
  • asset:read
  • asset:write

Limity

Na klucz API: żądanie 60 co 60 s na adres IP

Get Operation

GET /v1/operations/{operationId}

Żądanie

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

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

Odpowiedź:

200 - OK
Zwraca: object
path string
metadata object
done boolean
error object
response object

Wymagane uprawnienia

  • Odczyt
  • asset:read

Limity

Na klucz API: żądanie 60 co 60 s na adres IP

Obiekty

Następujące obiekty opisują ładunki, które są przyjmowane lub zwracane. Więcej informacji na temat tego, kiedy te obiekty są w użyciu, można znaleźć w poszczególnych punktach końcowych.

Any

Atrybuty

@type string

Asset

Atrybuty

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

Atrybuty

creator object
Wymagane
expectedPrice number

Creator

Atrybuty

userId number
groupId number

ModerationResult

Atrybuty

moderationState string

Operation

Atrybuty

path string
metadata object
done boolean
error object
response object

Preview

Atrybuty

asset string
altText string

Atrybuty

title string
uri string

Status

Atrybuty

code number
message string
details array<object>