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 parámetros de solicitud y respuesta para crear recursos en Roblox. Para obtener información sobre el uso de la API, see the Guía de uso .
Assets
Lista de versiones de activos
Lista todas las versiones de un recursoespecífico, con páginas opcionales.
Parámetros
El identificador único de la recurso.
Especifica la cantidad de versiones de activos para incluir en la respuesta. Los valores válidos se extienden de 1 a 50 (incluido). Los valores predeterminados son 8 cuando no se proporciona.
Un token para la pago. El valor se obtiene de una solicitud anterior y permite recuperar la siguiente página de versiones de activos.
Solicitud
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \
--header 'x-api-key: {apiKey}'Respuesta
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.
Los siguientes ámbitos son necesarios para que tu aplicación OAuth 2.0 use este extremo. Para obtener más información sobre cómo registrar una aplicación de OAuth 2.0, consulta Registro y revisión de aplicaciones.
Límites
Por clave API: 60 solicitudes cada 60 segundos por dirección IP
Versión de activo de reutilización
Revertir una actualización a una versión previa específica.
Parámetros
El identificador único de la recurso.
El camino de la versión de los activos en el formato de assets/{assetId}/versions/{versionNumber} .
Solicitud
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
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.
Los siguientes ámbitos son necesarios para que tu aplicación OAuth 2.0 use este extremo. Para obtener más información sobre cómo registrar una aplicación de OAuth 2.0, consulta Registro y revisión de aplicaciones.
Límites
Por clave API: 60 solicitudes cada 60 segundos por dirección IP
Obtener activo
Recupera contenido y metadatos de recursos específicos.
Parámetros
El identificador único de la recurso.
Campos de metadatos de activos para recuperar, incluida la descripción, el nombre de la pantalla, el ícono, los enlaces sociales y las previsualizaciones. Ejemplos: description%2CdisplayName , previews%2CtwitchSocialLink .
Solicitud
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \
--header 'x-api-key: {apiKey}'curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \
--header 'x-api-key: {apiKey}'Respuesta
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.
Los siguientes ámbitos son necesarios para que tu aplicación OAuth 2.0 use este extremo. Para obtener más información sobre cómo registrar una aplicación de OAuth 2.0, consulta Registro y revisión de aplicaciones.
Límites
Por clave API: 60 solicitudes cada 60 segundos por dirección IP
Crear Recurso
Crea un activo con el contenido y los metadatos proporcionados.
No puedes agregar recursoSocialLink cuando crees un objeto. En cambio, usa Actualizar Objeto .
Parámetros
Atributos de la propiedad para crear o actualización. Envíe como datos de formulario como se muestra el siguiente ejemplo de solicitud.
El binario de archivo de activos y el introducircontenido. Formato: fileContent=@"/filepath/{File}";type={ContentType} . Ejemplo: fileContent=@"/filepath/model.fbx";type=model/fbx . Ver Tipos de Contenido .
Solicitud
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
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.
Los siguientes ámbitos son necesarios para que tu aplicación OAuth 2.0 use este extremo. Para obtener más información sobre cómo registrar una aplicación de OAuth 2.0, consulta Registro y revisión de aplicaciones.
Límites
Por clave API: 60 solicitudes cada 60 segundos por dirección IP
Actualizar Recurso
Actualiza un activo con contenido y metadatos proporcionados, incluida la descripción, el nombre de la pantalla, el icono, los enlaces sociales y las previsualizaciones. Actualmente, solo se puede actualizar el cuerpo del contenido para Modelos . Los íconos y las previsualizaciones deben ser Imagen activos. Los íconos deben tener dimensiones cuadradas.
Parámetros
Envía como datos de formulario como las siguientes solicitudes de ejemplo.
El binario de archivo de activos y el introducircontenido. Formato: fileContent=@"/filepath/{File}";type={ContentType} . Ejemplo: fileContent=@"/filepath/model.fbx";type=model/fbx . Ver Tipos de Contenido .
Campos de metadatos de activos para actualización, incluyendo la descripción, el nombre de la pantalla, el íconoy las previsualizaciones. Ejemplos: description%2CdisplayName , previews%2CtwitchSocialLink .
Solicitud
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}\""'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}\"'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.\"}]}"'curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=twitchSocialLink%2CgithubSocialLink' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": \"{assetId}\", \"twitchSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://twitch.tv/your-channel\"}, \"githubSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://github.com/your-repo\"}}"'Respuesta
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.
Los siguientes ámbitos son necesarios para que tu aplicación OAuth 2.0 use este extremo. Para obtener más información sobre cómo registrar una aplicación de OAuth 2.0, consulta Registro y revisión de aplicaciones.
Límites
Por clave API: 60 solicitudes cada 60 segundos por dirección IP
Obtener la versión de la biblioteca
Recupera una versión de activo específica por el ID de activo y el número de versión.
Parámetros
El identificador único de la recurso.
El número de versión.
Solicitud
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \
--header 'x-api-key: {apiKey}'Respuesta
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.
Los siguientes ámbitos son necesarios para que tu aplicación OAuth 2.0 use este extremo. Para obtener más información sobre cómo registrar una aplicación de OAuth 2.0, consulta Registro y revisión de aplicaciones.
Límites
Por clave API: 60 solicitudes cada 60 segundos por dirección IP
Obtener Operación
Obtenga el resultado de una creación de activos o actualización utilizando el ID de operación devuelto. Requiere Leer para la autorización de la API y leer recursopara las aplicaciones OAuth 2.0.
Solicitud
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'Respuesta
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.
Los siguientes ámbitos son necesarios para que tu aplicación OAuth 2.0 use este extremo. Para obtener más información sobre cómo registrar una aplicación de OAuth 2.0, consulta Registro y revisión de aplicaciones.
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
Contiene un mensaje serializado arbitrario junto con un @type que describe el tipo del mensaje serializado.
Atributos
El tipo del mensaje serializado.
Asset
Representa un recurso.
Atributos
El identificador único de la recurso. Requerido para Actualizar Entidad .
El introducirde activo. Solo se puede Audio, Decal, o Model. Requerido para 2> Crear un activo2> .
El contexto de creación que no forma parte del contenido del activo, como metadatos y información del creador. Requerido para Crear un activo .
La descripción de la recurso. Límite de 1000 caracteres. Requerido para Crear propiedad .
Nombre de visualización de la recurso. Requerido para Crear una Asignación .
El camino de recursos para el ícono.
El resultado de la moderación de la recurso.
El camino de recursos devuelto de la asignación. Formato: assets/{assetId} . Ejemplo: assets/2205400862 .
Una lista de previsualizaciones, cada una con un camino de activo y texto alternativo. Las previsualizaciones deben ser Imagen activos.
La hora de creación de la revisión actual.
ID de revisión del recurso. Equivalente a versionNumber . Cada cambio del activo se comenta automáticamente una nueva versión. El formato es una cadena de números. Ejemplo: 1 .
Un enlace de redes sociales para el activo. Máximo de tres por recurso. El nombre del objeto puede ser cualquiera de: <
CreationContext
El contexto de creación que no forma parte del contenido del activo, como metadatos y información del creador. Requerido para Crear un activo .
Atributos
Representa a un creador.
Se espera una tasa de carga de activos en Robux. Cuando el precio real es más de lo esperado, la operación falla con un error 400.
Creator
Representa a un creador.
Atributos
El ID del Grupo. Requerido si el activo es propiedad del grupo.
El ID de usuario el creador. Requerido si el activo es propiedad de un usuario individual.
ModerationResult
El resultado de la moderación de la recurso.
Atributos
El estado de moderación de la recurso. Puede ser MODERATION_STATE_REVIEWING, MODERATION_STATE_REJECTED o MODERATION_STATE_APPROVED.
Operation
Este recurso representa una operación de larga duración que es el resultado de una llamada de API de red.
Atributos
Si false , la operación todavía está en progreso. Si true , la operación se completa.
El modelo de error lógico que explica el estado de error.
Contiene un mensaje serializado arbitrario junto con un @type que describe el tipo del mensaje serializado.
El camino de recursos asignado por el servidor. El formato por defecto es operations/{operation_id} .
Contiene un mensaje serializado arbitrario junto con un @type que describe el tipo del mensaje serializado.
Preview
Una vista previa de los recursos.
Atributos
Texto alternativo para la vista previa de los recursos.
El camino de los recursos de vista previa.
SocialLink
Un enlace de redes sociales para el activo. Máximo de tres por recurso. El nombre del objeto puede ser cualquiera de: <
Atributos
Un título opcional para el enlazarde las redes sociales. No se utiliza en el Centro del Creador.
La URL para el enlazarde las redes sociales. Debe coincidir con el formato esperado para el tipo de enlazar. Por ejemplo, el título para un objeto twitchSocialLink debe ser del formato https://twitch.tv/your-channel .
Status
El modelo de error lógico que explica el estado de error.
Atributos
El código de estado HTTP.
Una lista de mensajes que contienen detalles de error.
El mensaje de error.