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

Listar 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

200 - OK
Versiones de activos enumeradas con éxito.
Devuelve un(a) array<object>

Permisos obligatorios

Límites

Versión de activo de devolución

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

Parámetros

assetId string
Path
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

200 - OK
Recurso desplegado con éxito.
Devuelve un(a) object
creationContext object
moderationResult object
path string

Permisos obligatorios

Límites

Crear recurso

POST /v1/assets

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

Permisos obligatorios

Límites

Obtener recurso

GET /v1/assets/{assetId}

Parámetros

assetId string
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

200 - OK
Recurso de activo recuperado con éxito.
Devuelve un(a) object
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
state string

Permisos obligatorios

Límites

Actualizar recurso

PATCH /v1/assets/{assetId}

Parámetros

assetId string
Path
Obligatorio
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

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 operación para verificar el estado de actualización / Devuelve los campos de metadatos actualizados.
Devuelve un(a) object
application/json

{"previews": [
{"asset": "assets/123", "altText": "preview 1"},
{"asset": "assets/456", "altText": "preview 2"}
]}
done boolean
error object
metadata object
path string
response object

Permisos obligatorios

Límites

Obtener versión de activo

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

200 - OK
Versión de activo recuperada con éxito.
Devuelve un(a) object
creationContext object
moderationResult object
path string

Permisos obligatorios

Límites

Archivar activo

POST /v1/assets/{assetId}:archive

Parámetros

assetId string
Path
Obligatorio

Solicitud

Archive Asset

curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'

Respuesta

200 - OK
Archivo de activos exitosamente exitoso.
Devuelve un(a) object
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
state string

Permisos obligatorios

Límites

Restaurar activo

POST /v1/assets/{assetId}:restore

Parámetros

assetId string
Path
Obligatorio

Solicitud

Restore Asset

curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'

Respuesta

200 - OK
Recurso restaurado con éxito.
Devuelve un(a) object
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
state string

Permisos obligatorios

Límites

Obtener operación

GET /v1/operations/{operationId}

Parámetros

operationId string
Path
Obligatorio

Solicitud

Get Operation

curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'

Respuesta

200 - OK
Resultado de operación recuperado con éxito.
Devuelve un(a) object
done boolean
error object
metadata object
path string
response object

Permisos obligatorios

Límites

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
state string

AssetVersion

Atributos

creationContext object
moderationResult object
path string

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

State

Atributos

string (enum): "Unspecified", "Active", "Archived"

Status

Atributos

code number
details array<object>
message string