Assets API

Assets

https://apis.roblox.com/assets

Get Asset

GET /v1/assets

Parámetros

assetId Asset
Path
Obligatorio
readMask string

Solicitud

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

Respuesta

Permisos obligatorios

  • Leer
  • asset:read

Límites

Por clave API: 60 solicitudes cada 60 segundos por dirección IP

Create Asset

POST /v1/assets

Parámetros

request Asset
FormData
Obligatorio
fileContent string
FormData
Obligatorio

Solicitud

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'

Respuesta

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

Permisos obligatorios

  • Leer
  • Escribir
  • asset:read
  • asset:write

Límites

Por clave API: 60 solicitudes cada 60 segundos por dirección IP

Update Asset

PATCH /v1/assets/{assetId}

Parámetros

request Asset
FormData
Obligatorio
fileContent string
FormData
updateMask string

Solicitud

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

Respuesta

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

Permisos obligatorios

  • Leer
  • Escribir
  • asset:read
  • asset:write

Límites

Por clave API: 60 solicitudes cada 60 segundos por dirección IP

Get Asset Version

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

Parámetros

assetId string
Path
Obligatorio
versionNumber string
Path
Obligatorio

Solicitud

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

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

Respuesta

Permisos obligatorios

  • Leer
  • asset:read

Límites

Por clave API: 60 solicitudes cada 60 segundos por dirección IP

List Asset Versions

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

Parámetros

assetId string
Path
Obligatorio
maxPageSize number
pageToken string

Solicitud

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

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

Respuesta

Permisos obligatorios

  • Leer
  • Escribir
  • asset:read
  • asset:write

Límites

Por clave API: 60 solicitudes cada 60 segundos por dirección IP

Rollback Asset Version

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

Parámetros

assetId string
Path
Obligatorio
assetVersion string
FormData
Obligatorio

Solicitud

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

Respuesta

Permisos obligatorios

  • Leer
  • Escribir
  • asset:read
  • asset:write

Límites

Por clave API: 60 solicitudes cada 60 segundos por dirección IP

Get Operation

GET /v1/operations/{operationId}

Solicitud

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

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

Respuesta

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

Permisos obligatorios

  • Leer
  • asset:read

Límites

Por clave API: 60 solicitudes cada 60 segundos por dirección IP

Objetos

Los siguientes objetos describen cargas que son aceptadas o devueltas. Ve cada extremo para más información sobre cuándo se utilizan estos objetos.

Any

Atributos

@type string
Obligatorio

Asset

Atributos

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

CreationContext

Atributos

creator Creator
Obligatorio
expectedPrice number
Obligatorio

Creator

Atributos

userId number
Obligatorio
groupId number
Obligatorio

ModerationResult

Atributos

moderationState string
Obligatorio

Operation

Atributos

path string
Obligatorio
metadata Any
Obligatorio
done boolean
Obligatorio
error Status
Obligatorio
response Any
Obligatorio

Preview

Atributos

asset string
Obligatorio
altText string
Obligatorio

Status

Atributos

code number
Obligatorio
message string
Obligatorio
details array<Any>
Obligatorio