API de activos

*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.

Assets

https://apis.roblox.com/assets

Lista de versiones de activos

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
  • asset:read

Límites

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

Versión de activo de reutilización

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

Obtener activo

GET /v1/assets

Parámetros

assetId
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

Crear Recurso

POST /v1/assets

Parámetros

request
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
Devuelve el ID de la operación para comprobar el estado de la creación.
Devuelve un(a) object
done boolean
error object
metadata object
path string
response object

Permisos obligatorios

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

Límites

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

Actualizar Recurso

PATCH /v1/assets/{assetId}

Parámetros

request
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.\"}]}"'
Update Social Links

Respuesta

200 - OK
Devuelve el ID de la operación para verificar el estado de actualización / Devuelve los campos de metadatos actualizados.
Devuelve un(a) object
application/json
{\"previews\": [\n    {\"asset\": \"assets/123\", \"altText\": \"preview 1\"},\n    {\"asset\": \"assets/456\", \"altText\": \"preview 2\"}\n]}
done boolean
error object
metadata object
path string
response object

Permisos obligatorios

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

Límites

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

Obtener la versión de la biblioteca

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

Obtener Operación

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

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

Asset

Atributos

assetId number
assetType string
creationContext object
description string
displayName string
icon string
moderationResult object
path string
previews array<object>
revisionCreateTime string
revisionId string
socialLink object

CreationContext

Atributos

creator object
Obligatorio
expectedPrice number

Creator

Atributos

groupId number
userId number

ModerationResult

Atributos

moderationState string

Operation

Atributos

done boolean
error object
metadata object
path string
response object

Preview

Atributos

altText string
asset string

Atributos

title string
uri string

Status

Atributos

code number
details array<object>
message string