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í.

Puedes enviar y recibir los siguientes paquetes de solicitudes y respuestas para crear recursos en Roblox.Para obtener información sobre el uso de la API, consulte el guía de uso.

Assets

https://apis.roblox.com/assets

Listar versiones de activos

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

Lista todas las versiones de un recursoespecífico, con página opcional.

Parámetros

assetId string

El identificador único del recurso.

Path
Obligatorio
maxPageSize number

Specifica el número de versiones de activos que se incluyen en la respuesta. Los valores válidos van de 1 a 50 (inclusivo). Se predetermina a 8 cuando no se proporciona.

pageToken string

Una etiqueta para la página. El valor se obtiene de una solicitud anterior y permite recuperar la siguiente página de versiones de activos.

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

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Leer

Límites
  • Claves API: 100 requests per minute across all API keys for a user or group
  • OAuth2: 1000 requests per minute per app user

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.

Versión de activo de devolución

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

Retroceder un activo a una versión anterior específica.

Proporcione el camino de versión de activo en los datos de la forma.

Parámetros

assetId string

El identificador único del recurso.

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

El contexto de creación que no forma parte del contenido de los activos, como la información de metadatos y creador. Requerido para Crear activo.

moderationResult object

El resultado de moderación del recurso.

path string

El camino de recursos devuelto de la versión del activo. Formato: assets/{assetId}/versions/{version} . Ejemplo: assets/2205400862/versions/1 .

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Leer

  • Escribir

Límites
  • Claves API: 100 requests per minute across all API keys for a user or group
  • OAuth2: 1000 requests per minute per app user

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.

Crear recurso

POST /v1/assets

Crea un activo con el contenido y los metadatos proporcionados.

No puedes agregar objetos Enlace social cuando creas un activo. En cambio, usa Actualizar activo.

Proporcione el recurso, ruta de archivo binario, y tipo de contenido en los datos de la forma.

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

Si false , la operación sigue en curso. Si true , la operación se completa.

error object

El modelo de error lógico que explica el estado de error.

metadata object

Contiene un mensaje serializado arbitrario junto con un @type que describe el tipo del mensaje serializado.

path string

El camino de recursos asignado por el servidor. El formato predeterminado es operations/{operation_id} .

response object

Contiene un mensaje serializado arbitrario junto con un @type que describe el tipo del mensaje serializado.

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Leer

  • Escribir

Límites
  • Claves API: 60 requests per minute across all API keys for a user or group
  • OAuth2: 1000 requests per minute per app user

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.

Obtener recurso

GET /v1/assets/{assetId}

Recuperar contenido y metadatos de activos específicos.

Parámetros

assetId string

El identificador único del recurso.

Path
Obligatorio
readMask string

Campos de metadatos de activos para recuperar, incluidos la descripción, el nombre de visualización, el ícono, los enlaces sociales y las previas. Ejemplos: description%2CdisplayName , previews%2CtwitchSocialLink .

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

El identificador único del recurso. Requerido para actualizar el recurso.

assetType string

El introducirde recurso. Solo puede ser Audio , Decal o Model . Requerido para Crear recurso .

creationContext object

El contexto de creación que no forma parte del contenido de los activos, como la información de metadatos y creador. Requerido para Crear activo.

description string

La descripción del recurso. Límite de 1000 caracteres. Requerido para Crear recurso.

displayName string

Nombre de visualización del recurso. Requerido para Crear recurso.

icon string

El camino de recursos para el ícono.

moderationResult object

El resultado de moderación del recurso.

path string

El camino de recursos devuelto de la entidad. Formato: assets/{assetId} . Ejemplo: assets/2205400862 .

previews array<object>

Una lista de previsualizaciones, cada una con un camino de activos y texto alternativo. Las previsualizaciones deben ser Imágenes activos.

revisionCreateTime string

El tiempo de creación de la revisión actual.

revisionId string

ID de revisión del activo.Equivalente a versionNumber .Cada cambio del recurso se comite automáticamente una nueva versión.El formato es una cadena de números enteros.Ejemplo: 1 .

socialLink object

Un enlace de redes sociales para el activo.Máximo de tres por activo.El nombre del objeto puede ser cualquiera de:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
Para la sintaxis, consulte la solicitud de muestra bajo Actualizar recurso.

state string

Si el activo está activo o archivado. Unspecified no se usa.

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Leer

Límites
  • Claves API: 60 requests per minute across all API keys for a user or group
  • OAuth2: 1000 requests per minute per app user

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.

Actualizar recurso

PATCH /v1/assets/{assetId}

Actualiza un recurso con el contenido y los metadatos proporcionados, incluida la descripción, el nombre de visualización, el ícono, los enlaces sociales y las previas.Actualmente solo se puede actualizar el cuerpo de contenido para modelos .Las iconos y previas deben ser activos de imagen .Las iconos deben tener dimensiones cuadradas.

Proporcione el recurso, ruta de archivo binario, y tipo de contenido en los datos de la forma.

Parámetros

assetId string

El identificador único del recurso.

Path
Obligatorio
updateMask string

Campos de metadatos de activos para actualización, incluidos la descripción, el nombre de visualización, el íconoy las previas. Ejemplos: description%2CdisplayName , previews%2CtwitchSocialLink .

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

Si false , la operación sigue en curso. Si true , la operación se completa.

error object

El modelo de error lógico que explica el estado de error.

metadata object

Contiene un mensaje serializado arbitrario junto con un @type que describe el tipo del mensaje serializado.

path string

El camino de recursos asignado por el servidor. El formato predeterminado es operations/{operation_id} .

response object

Contiene un mensaje serializado arbitrario junto con un @type que describe el tipo del mensaje serializado.

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Leer

  • Escribir

Límites
  • Claves API: 60 requests per minute across all API keys for a user or group
  • OAuth2: 1000 requests per minute per app user

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.

Obtener versión de activo

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

Recupera una versión específica de un activo por el ID del activo y el número de versión.

Parámetros

assetId string

El identificador único del recurso.

Path
Obligatorio
versionNumber string

El número de versión.

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

El contexto de creación que no forma parte del contenido de los activos, como la información de metadatos y creador. Requerido para Crear activo.

moderationResult object

El resultado de moderación del recurso.

path string

El camino de recursos devuelto de la versión del activo. Formato: assets/{assetId}/versions/{version} . Ejemplo: assets/2205400862/versions/1 .

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Leer

Límites
  • Claves API: 100 requests per minute across all API keys for a user or group
  • OAuth2: 1000 requests per minute per app user

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.

Archivar activo

POST /v1/assets/{assetId}:archive

Archiva el recurso.Los recursos archivados desaparecen del sitio web y ya no son utilizables o visibles en las experiencias de Roblox, pero puedes restaurarlos.

Parámetros

assetId string

El identificador único del recurso.

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

El identificador único del recurso. Requerido para actualizar el recurso.

assetType string

El introducirde recurso. Solo puede ser Audio , Decal o Model . Requerido para Crear recurso .

creationContext object

El contexto de creación que no forma parte del contenido de los activos, como la información de metadatos y creador. Requerido para Crear activo.

description string

La descripción del recurso. Límite de 1000 caracteres. Requerido para Crear recurso.

displayName string

Nombre de visualización del recurso. Requerido para Crear recurso.

icon string

El camino de recursos para el ícono.

moderationResult object

El resultado de moderación del recurso.

path string

El camino de recursos devuelto de la entidad. Formato: assets/{assetId} . Ejemplo: assets/2205400862 .

previews array<object>

Una lista de previsualizaciones, cada una con un camino de activos y texto alternativo. Las previsualizaciones deben ser Imágenes activos.

revisionCreateTime string

El tiempo de creación de la revisión actual.

revisionId string

ID de revisión del activo.Equivalente a versionNumber .Cada cambio del recurso se comite automáticamente una nueva versión.El formato es una cadena de números enteros.Ejemplo: 1 .

socialLink object

Un enlace de redes sociales para el activo.Máximo de tres por activo.El nombre del objeto puede ser cualquiera de:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
Para la sintaxis, consulte la solicitud de muestra bajo Actualizar recurso.

state string

Si el activo está activo o archivado. Unspecified no se usa.

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Leer

  • Escribir

Límites
  • Claves API: 100 requests per minute across all API keys for a user or group
  • OAuth2: 1000 requests per minute per app user

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.

Restaurar activo

POST /v1/assets/{assetId}:restore

Restaura un recurso archivado.

Parámetros

assetId string

El identificador único del recurso.

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

El identificador único del recurso. Requerido para actualizar el recurso.

assetType string

El introducirde recurso. Solo puede ser Audio , Decal o Model . Requerido para Crear recurso .

creationContext object

El contexto de creación que no forma parte del contenido de los activos, como la información de metadatos y creador. Requerido para Crear activo.

description string

La descripción del recurso. Límite de 1000 caracteres. Requerido para Crear recurso.

displayName string

Nombre de visualización del recurso. Requerido para Crear recurso.

icon string

El camino de recursos para el ícono.

moderationResult object

El resultado de moderación del recurso.

path string

El camino de recursos devuelto de la entidad. Formato: assets/{assetId} . Ejemplo: assets/2205400862 .

previews array<object>

Una lista de previsualizaciones, cada una con un camino de activos y texto alternativo. Las previsualizaciones deben ser Imágenes activos.

revisionCreateTime string

El tiempo de creación de la revisión actual.

revisionId string

ID de revisión del activo.Equivalente a versionNumber .Cada cambio del recurso se comite automáticamente una nueva versión.El formato es una cadena de números enteros.Ejemplo: 1 .

socialLink object

Un enlace de redes sociales para el activo.Máximo de tres por activo.El nombre del objeto puede ser cualquiera de:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
Para la sintaxis, consulte la solicitud de muestra bajo Actualizar recurso.

state string

Si el activo está activo o archivado. Unspecified no se usa.

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Leer

  • Escribir

Límites
  • Claves API: 100 requests per minute across all API keys for a user or group
  • OAuth2: 1000 requests per minute per app user

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.

Obtener operación

GET /v1/operations/{operationId}

Obtenga el resultado de la creación o actualización de un activo utilizando el ID de operación devuelto.Requiere Leer para el permiso de clave de API y leer activo para las aplicaciones de OAuth 2.0.

Parámetros

operationId string

El identificador único de la operación.

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

Si false , la operación sigue en curso. Si true , la operación se completa.

error object

El modelo de error lógico que explica el estado de error.

metadata object

Contiene un mensaje serializado arbitrario junto con un @type que describe el tipo del mensaje serializado.

path string

El camino de recursos asignado por el servidor. El formato predeterminado es operations/{operation_id} .

response object

Contiene un mensaje serializado arbitrario junto con un @type que describe el tipo del mensaje serializado.

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Leer

Límites
  • Claves API: 100 requests per minute across all API keys for a user or group
  • OAuth2: 1000 requests per minute per app user

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.

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

Contiene un mensaje serializado arbitrario junto con un @type que describe el tipo del mensaje serializado.

Atributos

@type string

El tipo del mensaje serializado.

Asset

Representa un recurso.

Atributos

assetId number

El identificador único del recurso. Requerido para actualizar el recurso.

assetType string

El introducirde recurso. Solo puede ser Audio , Decal o Model . Requerido para Crear recurso .

creationContext object

El contexto de creación que no forma parte del contenido de los activos, como la información de metadatos y creador. Requerido para Crear activo.

description string

La descripción del recurso. Límite de 1000 caracteres. Requerido para Crear recurso.

displayName string

Nombre de visualización del recurso. Requerido para Crear recurso.

icon string

El camino de recursos para el ícono.

moderationResult object

El resultado de moderación del recurso.

path string

El camino de recursos devuelto de la entidad. Formato: assets/{assetId} . Ejemplo: assets/2205400862 .

previews array<object>

Una lista de previsualizaciones, cada una con un camino de activos y texto alternativo. Las previsualizaciones deben ser Imágenes activos.

revisionCreateTime string

El tiempo de creación de la revisión actual.

revisionId string

ID de revisión del activo.Equivalente a versionNumber .Cada cambio del recurso se comite automáticamente una nueva versión.El formato es una cadena de números enteros.Ejemplo: 1 .

socialLink object

Un enlace de redes sociales para el activo.Máximo de tres por activo.El nombre del objeto puede ser cualquiera de:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
Para la sintaxis, consulte la solicitud de muestra bajo Actualizar recurso.

state string

Si el activo está activo o archivado. Unspecified no se usa.

AssetVersion

Una versión de activo.

Atributos

creationContext object

El contexto de creación que no forma parte del contenido de los activos, como la información de metadatos y creador. Requerido para Crear activo.

moderationResult object

El resultado de moderación del recurso.

path string

El camino de recursos devuelto de la versión del activo. Formato: assets/{assetId}/versions/{version} . Ejemplo: assets/2205400862/versions/1 .

CreationContext

El contexto de creación que no forma parte del contenido de los activos, como la información de metadatos y creador. Requerido para Crear activo.

Atributos

creator object

Representa a un creador.

Obligatorio
expectedPrice number

Tarifa de subida de activos esperada en Robux. Cuando el precio real es mayor al esperado, la operación falla con un error 400.

Creator

Representa a un creador.

Atributos

groupId number

El ID del grupo. Requerido si el activo es de propiedad del grupo.

userId number

El ID de usuario al creador. Requerido si el activo es de propiedad individual del usuario.

ModerationResult

El resultado de moderación del recurso.

Atributos

moderationState string

El estado de moderación del recurso. Puede ser Reviewing , Rejected o Approved .

Operation

Esta recurso representa una operación de larga duración que es el resultado de una llamada de API de red.

Atributos

done boolean

Si false , la operación sigue en curso. Si true , la operación se completa.

error object

El modelo de error lógico que explica el estado de error.

metadata object

Contiene un mensaje serializado arbitrario junto con un @type que describe el tipo del mensaje serializado.

path string

El camino de recursos asignado por el servidor. El formato predeterminado es operations/{operation_id} .

response object

Contiene un mensaje serializado arbitrario junto con un @type que describe el tipo del mensaje serializado.

Preview

Una vista previa de un activo.

Atributos

altText string

Texto alternativo para el activo de vista previa.

asset string

El camino de activo de vista previa.

Un enlace de redes sociales para el activo.Máximo de tres por activo.El nombre del objeto puede ser cualquiera de:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
Para la sintaxis, consulte la solicitud de muestra bajo Actualizar recurso.

Atributos

title string

Un título opcional para el enlazarde redes sociales. No se usa en el Centro de creadores.

uri string

La URI para el enlazarde redes sociales.Debe coincidir con el formato esperado para el tipo de enlazar.Por ejemplo, el título de un objeto twitchSocialLink debe ser de formato https://twitch.tv/your-channel.

State

Si el activo está activo o archivado. Unspecified no se usa.

Atributos

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

Status

El modelo de error lógico que explica el estado de error.

Atributos

code number

El código de estado HTTP.

details array<object>

Una lista de mensajes que llevan detalles de error.

message string

El mensaje de error.