Assets API

Assets

https://apis.roblox.com/assets

Get Asset

GET /v1/assets

Parâmetros

assetId Asset
Path
Obrigatório
readMask string

Solicitação

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

Resposta

Permissões necessárias

  • Ler
  • asset:read

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

Create Asset

POST /v1/assets

Parâmetros

request Asset
FormData
Obrigatório
fileContent string
FormData
Obrigatório

Solicitação

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'

Resposta

200 - OK
Returns the Operation ID for checking the creation status.
Retorna um(a) object: Operation
path string
metadata Any
done boolean
error Status
response Any

Permissões necessárias

  • Ler
  • Escrever
  • asset:read
  • asset:write

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

Update Asset

PATCH /v1/assets/{assetId}

Parâmetros

request Asset
FormData
Obrigatório
fileContent string
FormData
updateMask string

Solicitação

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

Resposta

200 - OK
Returns the Operation ID for checking the update status / Returns the updated metadata fields.
Retorna um(a) object: Operation
path string
metadata Any
done boolean
error Status
response Any

Permissões necessárias

  • Ler
  • Escrever
  • asset:read
  • asset:write

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

Get Asset Version

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

Parâmetros

assetId string
Path
Obrigatório
versionNumber string
Path
Obrigatório

Solicitação

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

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

Resposta

Permissões necessárias

  • Ler
  • asset:read

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

List Asset Versions

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

Parâmetros

assetId string
Path
Obrigatório
maxPageSize number
pageToken string

Solicitação

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

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

Resposta

Permissões necessárias

  • Ler
  • Escrever
  • asset:read
  • asset:write

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

Rollback Asset Version

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

Parâmetros

assetId string
Path
Obrigatório
assetVersion string
FormData
Obrigatório

Solicitação

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

Resposta

Permissões necessárias

  • Ler
  • Escrever
  • asset:read
  • asset:write

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

Get Operation

GET /v1/operations/{operationId}

Solicitação

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

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

Resposta

200 - OK
Retorna um(a) object: Operation
path string
metadata Any
done boolean
error Status
response Any

Permissões necessárias

  • Ler
  • asset:read

Limites

Por chave de API: 60 solicitações a cada 60 segundos por endereço IP

Objetos

Os seguintes objetos descrevem payloads que são aceitos ou retornados. Veja cada endpoint para mais informações sobre quando esses objetos são usados.

Any

Atributos

@type string
Obrigatório

Asset

Atributos

assetType string
Obrigatório
assetId number
Obrigatório
creationContext CreationContext
Obrigatório
description string
Obrigatório
displayName string
Obrigatório
path string
Obrigatório
revisionId string
Obrigatório
revisionCreateTime string
Obrigatório
moderationResult ModerationResult
Obrigatório
icon string
Obrigatório
previews array<Preview>
Obrigatório

CreationContext

Atributos

creator Creator
Obrigatório
expectedPrice number
Obrigatório

Creator

Atributos

userId number
Obrigatório
groupId number
Obrigatório

ModerationResult

Atributos

moderationState string
Obrigatório

Operation

Atributos

path string
Obrigatório
metadata Any
Obrigatório
done boolean
Obrigatório
error Status
Obrigatório
response Any
Obrigatório

Preview

Atributos

asset string
Obrigatório
altText string
Obrigatório

Status

Atributos

code number
Obrigatório
message string
Obrigatório
details array<Any>
Obrigatório