API des ressources

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Vous pouvez envoyer et recevoir les demandes et les réponses suivantes pour créer des ressources sur Roblox. Pour plus d'informations sur l'utilisation de l'API, voir le guide d'utilisation.

Assets

https://apis.roblox.com/assets

Liste des versions des ressources

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

Listez toutes les versions d'une contenuspécifique, avec une pagination facultative.

Paramètres

assetId string

L'identifiant unique de la contenu.

Path
Requis
maxPageSize number

Spécifie le nombre de versions de ressources à inclure dans la réponse. Les valeurs valides vont de 1 à 50 (y compris). Les valeurs par défaut vont de 8 lorsqu'elles ne sont pas fournies.

pageToken string

Un jeton pour la pagination. La valeur est obtenue à partir d'une demande précédente et permet de récupérer la prochaine page des versions des ressources.

Requête

List Asset Versions
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \

--header 'x-api-key: {apiKey}'

Réponse

Autorisations requises

Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).

  • Lire

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révision d'une application]. (/cloud/auth/oauth2-overview).

  • asset:read

Limitations

Par clé API : 60 demande toutes les 60 secondes par adresse IP

Version de l'ancienne version des ressources

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

Renvoie une ressource à une version précédente spécifique.

Paramètres

assetId string

L'identifiant unique de la contenu.

Path
Requis
assetVersion string

La voie de la version des ressources au format assets/{assetId}/versions/{versionNumber} .

FormData
Requis

Requête

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}\"}'

Réponse

Autorisations requises

Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).

  • Lire

  • Écrire

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révision d'une application]. (/cloud/auth/oauth2-overview).

  • asset:read

  • asset:write

Limitations

Par clé API : 60 demande toutes les 60 secondes par adresse IP

Obtenir ressource

GET /v1/assets

Récupérez du contenu et des métadonnées spécifiques.

Paramètres

assetId

L'identifiant unique de la contenu.

Path
Requis
readMask string

Métadonnées des ressources à récupérer, y compris la description, le nom d'affichage, l'icône, les liens sociaux et les aperçus. Exemples : description%2CdisplayName , previews%2CtwitchSocialLink .

Requête

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

Réponse

Autorisations requises

Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).

  • Lire

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révision d'une application]. (/cloud/auth/oauth2-overview).

  • asset:read

Limitations

Par clé API : 60 demande toutes les 60 secondes par adresse IP

Créer un élément

POST /v1/assets

Crée une ressource avec du contenu fourni et des métadonnées.

Vous ne pouvez pas ajouter d'objets SocialLink lorsque vous créez une contenu. Au lieu de cela, utilisez Mettre à jour la ressource .

Paramètres

request

Attributs des ressources à créer ou à mettre à mise à jour. Envoyez comme des données de formulaires comme la demande d'exemple suivante montre.

FormData
Requis
fileContent string

Le chemin du fichier de ressources binaire et le tapercontenu.格式: fileContent=@"/filepath/{File}";type={ContentType} . Exemple: fileContent=@"/filepath/model.fbx";type=model/fbx . Voir types de contenu .

FormData
Requis

Requête

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'

Réponse

200 - OK
Renvoie l'ID de l'opération pour vérifier le statut de création.
Renvoie une object
done boolean

Si false, l'opération est toujours en cours. Si true, l'opération est terminée.

error object

Le modèle d'erreur logique expliquant l'statutd'erreur.

metadata object

Contient un message sérialisé arbitraire ainsi qu'un @type qui décrit le type du message sérialisé.

path string

Chemin de ressource affecté au serveur. Le format par défaut est operations/{operation_id} .

response object

Contient un message sérialisé arbitraire ainsi qu'un @type qui décrit le type du message sérialisé.

Autorisations requises

Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).

  • Lire

  • Écrire

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révision d'une application]. (/cloud/auth/oauth2-overview).

  • asset:read

  • asset:write

Limitations

Par clé API : 60 demande toutes les 60 secondes par adresse IP

Mettre à jour la ressource

PATCH /v1/assets/{assetId}

Mise à jour un ressource avec du contenu et des métadonnées fournis, y compris la description, le nom d'affichage, l'icône, les liens sociaux et les prévisualisations. Actuellement, vous ne pouvez mettre à jour que le corps du contenu pour Models . Les icônes et les prévisualisations doivent être des ressources d'image. Les icônes doivent avoir des dimensions carrées.

Paramètres

request

Envoyez des données de forme comme les demandes d'exemple suivantes.

FormData
Requis
fileContent string

Le chemin du fichier de ressources binaire et le tapercontenu.格式: fileContent=@"/filepath/{File}";type={ContentType} . Exemple: fileContent=@"/filepath/model.fbx";type=model/fbx . Voir types de contenu .

FormData
updateMask string

Métadonnées des ressources à mettre à mise à jour, y compris la description, le Nom d'affichaged'affichage, l'icône et les aperçus. Exemples : description%2CdisplayName , previews%2CtwitchSocialLink .

Requête

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

Réponse

200 - OK
Renvoie l'ID de l'opération pour vérifier le statut de mise à jour / Renvoie les champs de métadonnées mis à jour.
Renvoie une object
application/json
{\"previews\": [\n    {\"asset\": \"assets/123\", \"altText\": \"preview 1\"},\n    {\"asset\": \"assets/456\", \"altText\": \"preview 2\"}\n]}
done boolean

Si false, l'opération est toujours en cours. Si true, l'opération est terminée.

error object

Le modèle d'erreur logique expliquant l'statutd'erreur.

metadata object

Contient un message sérialisé arbitraire ainsi qu'un @type qui décrit le type du message sérialisé.

path string

Chemin de ressource affecté au serveur. Le format par défaut est operations/{operation_id} .

response object

Contient un message sérialisé arbitraire ainsi qu'un @type qui décrit le type du message sérialisé.

Autorisations requises

Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).

  • Lire

  • Écrire

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révision d'une application]. (/cloud/auth/oauth2-overview).

  • asset:read

  • asset:write

Limitations

Par clé API : 60 demande toutes les 60 secondes par adresse IP

Obtenez la version de l'actif

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

Récupérez une version spécifique d'une ressource par son ID et le numéro de version.

Paramètres

assetId string

L'identifiant unique de la contenu.

Path
Requis
versionNumber string

Le numéro de version.

Path
Requis

Requête

Get Asset Version
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \

--header 'x-api-key: {apiKey}'

Réponse

Autorisations requises

Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).

  • Lire

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révision d'une application]. (/cloud/auth/oauth2-overview).

  • asset:read

Limitations

Par clé API : 60 demande toutes les 60 secondes par adresse IP

Obtenez l'opération

GET /v1/operations/{operationId}

Obtenez le résultat d'une création ou d'une mise à jour d'une ressource en utilisant l'ID d'opération renvoyé. Requiert Lire pour la permission de la clé API et lire pour les applications OAuth 2.0.

Requête

Get Operation
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \

--header 'x-api-key: {apiKey}'

Réponse

200 - OK
Renvoie une object
done boolean

Si false, l'opération est toujours en cours. Si true, l'opération est terminée.

error object

Le modèle d'erreur logique expliquant l'statutd'erreur.

metadata object

Contient un message sérialisé arbitraire ainsi qu'un @type qui décrit le type du message sérialisé.

path string

Chemin de ressource affecté au serveur. Le format par défaut est operations/{operation_id} .

response object

Contient un message sérialisé arbitraire ainsi qu'un @type qui décrit le type du message sérialisé.

Autorisations requises

Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).

  • Lire

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révision d'une application]. (/cloud/auth/oauth2-overview).

  • asset:read

Limitations

Par clé API : 60 demande toutes les 60 secondes par adresse IP

Objets

Les objets suivants décrivent les charges utiles qui sont acceptées ou renvoyées. Voir chaque point de terminaison individuel pour plus d'informations sur l'utilisation de ces objets.

Any

Contient un message sérialisé arbitraire ainsi qu'un @type qui décrit le type du message sérialisé.

Attributs

@type string

Le type du message sérialisé.

Asset

Représente une contenu.

Attributs

assetId number

L'identifiant unique de la contenu. Requis pour Mettre à jour la ressource .

assetType string

Le taperde ressource. Ne peut être que Audio , Decal , ou Model . Requis pour 1> Créer une ressource1> .

creationContext object

Le contexte de création qui n'est pas une partie du contenu de l'actif, comme les métadonnées et les informations sur le créateur. Requis pour Créer un élément .

description string

Description de la contenu. Limite de 1000 caractères. Requis pour Créer une ressource .

displayName string

Nom d'affichage de la contenu. Requis pour Créer une ressource .

icon string

Chemin de ressource pour l'icône.

moderationResult object

Résultat de la modération de la contenu.

path string

Chemin de ressource retourné de la contenu. Format : assets/{assetId} . Exemple : assets/2205400862 .

previews array<object>

Une liste de prévisualisations, chacune avec un chemin de ressource et un texte alternatif. Les prévisualisations doivent être des ressources Image .

revisionCreateTime string

La création du timbre de la révision actuelle.

revisionId string

ID de révision de la contenu. Équivalent à versionNumber . Tout changement de la ressource se commente automatiquement par une nouvelle version. Le format est une chaîne entière. Exemple: 1 .

socialLink object

Un lien social pour la contenu. Maximum de trois par contenu. Le nom de l'objet peut être n'importe lequel : <

CreationContext

Le contexte de création qui n'est pas une partie du contenu de l'actif, comme les métadonnées et les informations sur le créateur. Requis pour Créer un élément .

Attributs

creator object

Représente un créateur.

Requis
expectedPrice number

Frais de téléchargement des ressources attendus en Robux. Lorsque le prix réel est supérieur à ce à quoi on pourrait s'attendre, l'opération échoue avec une erreur 400.

Creator

Représente un créateur.

Attributs

groupId number

L'ID de groupe. Requis si la ressource appartient à un groupe.

userId number

L'ID utilisateur le créateur. Requis si la ressource est de l'utilisateur individuel.

ModerationResult

Résultat de la modération de la contenu.

Attributs

moderationState string

L'état de modération des contenu. Peut être MODERATION_STATE_REVIEWING, MODERATION_STATE_REJECTED, ou MODERATION_STATE_APPROVED.

Operation

Cette ressource représente une opération en cours de longue durée qui est le résultat d'un appel d'API réseau.

Attributs

done boolean

Si false, l'opération est toujours en cours. Si true, l'opération est terminée.

error object

Le modèle d'erreur logique expliquant l'statutd'erreur.

metadata object

Contient un message sérialisé arbitraire ainsi qu'un @type qui décrit le type du message sérialisé.

path string

Chemin de ressource affecté au serveur. Le format par défaut est operations/{operation_id} .

response object

Contient un message sérialisé arbitraire ainsi qu'un @type qui décrit le type du message sérialisé.

Preview

Un aperçu des ressources.

Attributs

altText string

Texte alternatif pour la contenude prévisualisation.

asset string

La voie d'accès de l'aperçu.

Un lien social pour la contenu. Maximum de trois par contenu. Le nom de l'objet peut être n'importe lequel : <

Attributs

title string

Un titre facultatif pour le lien des médias sociaux. Ne pas utiliser sur le hub du créateur.

uri string

L'URL pour le lierdes médias sociaux. Doit correspondre au format attendu pour le type de lier. Par exemple, le titre pour un objet twitchSocialLink doit être du format https://twitch.tv/your-channel.

Status

Le modèle d'erreur logique expliquant l'statutd'erreur.

Attributs

code number

Le code d'état HTTP.

details array<object>

Une liste de messages comportant des détails d'erreur.

message string

Le message d'erreur.