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
Listar versiones de activos
Lista todas las versiones de un recursoespecífico, con página opcional.
Parámetros
El identificador único del recurso.
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.
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
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.
Versión de activo de devolución
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
El identificador único del recurso.
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.
Crear recurso
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
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.
Obtener recurso
Recuperar contenido y metadatos de activos específicos.
Parámetros
El identificador único del recurso.
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
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.
Actualizar recurso
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
El identificador único del recurso.
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
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.
Obtener versión de activo
Recupera una versión específica de un activo por el ID del activo y el número de versión.
Parámetros
El identificador único del 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.
Archivar activo
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
El identificador único del recurso.
Solicitud
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'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.
Restaurar activo
Restaura un recurso archivado.
Parámetros
El identificador único del recurso.
Solicitud
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'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.
Obtener operación
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
El identificador único de la operación.
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.
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 del recurso. Requerido para actualizar el recurso.
El introducirde recurso. Solo puede ser Audio , Decal o Model . Requerido para Crear recurso .
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.
La descripción del recurso. Límite de 1000 caracteres. Requerido para Crear recurso.
Nombre de visualización del recurso. Requerido para Crear recurso.
El camino de recursos para el ícono.
El resultado de moderación del recurso.
El camino de recursos devuelto de la entidad. Formato: assets/{assetId} . Ejemplo: assets/2205400862 .
Una lista de previsualizaciones, cada una con un camino de activos y texto alternativo. Las previsualizaciones deben ser Imágenes activos.
El tiempo de creación de la revisión actual.
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 .
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
Si el activo está activo o archivado. Unspecified no se usa.
AssetVersion
Una versión de activo.
Atributos
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.
El resultado de moderación del recurso.
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
Representa a un creador.
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
El ID del grupo. Requerido si el activo es de propiedad del grupo.
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
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
Si false , la operación sigue en curso. 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 predeterminado 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 un activo.
Atributos
Texto alternativo para el activo de vista previa.
El camino de activo de vista previa.
SocialLink
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
Atributos
Un título opcional para el enlazarde redes sociales. No se usa en el Centro de creadores.
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
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 llevan detalles de error.
El mensaje de error.