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.
Assets
https://apis.roblox.com/assets
Listez les versions des ressources
GET /assets/v1/assets/{assetId}/versions
Paramètres
assetId string
Path
Requis
maxPageSize number
pageToken string
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
Autres codes de statut
Autorisations requises
Limitations
Version de la ressource de rétrogradation
POST /assets/v1/assets/{assetId}/versions:rollback
Paramètres
assetId string
Path
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
Autres codes de statut
Autorisations requises
Limitations
Créer une ressource
POST /v1/assets
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
Autres codes de statut
Autorisations requises
Limitations
Obtenir une ressource
GET /v1/assets/{assetId}
Paramètres
assetId string
Path
Requis
readMask string
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
Autres codes de statut
Autorisations requises
Limitations
Mettre à jour la ressource
PATCH /v1/assets/{assetId}
Paramètres
assetId string
Path
Requis
updateMask string
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
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\"}}"'
Réponse
Autres codes de statut
Autorisations requises
Limitations
Obtenir la version des ressources
GET /v1/assets/{assetId}/versions/{versionNumber}
Paramètres
assetId string
Path
Requis
versionNumber string
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
Autres codes de statut
Autorisations requises
Limitations
Ressource d'archive
POST /v1/assets/{assetId}:archive
Paramètres
assetId string
Path
Requis
Requête
Archive Asset
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'
Réponse
Autres codes de statut
Autorisations requises
Limitations
Récupérer la ressource
POST /v1/assets/{assetId}:restore
Paramètres
assetId string
Path
Requis
Requête
Restore Asset
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'
Réponse
Autres codes de statut
Autorisations requises
Limitations
Obtenir une opération
GET /v1/operations/{operationId}
Paramètres
operationId string
Path
Requis
Requête
Get Operation
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'
Réponse
Autres codes de statut
Autorisations requises
Limitations
Objets
Any
Attributs
@type string
Asset
Attributs
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
Attributs
creationContext object
moderationResult object
path string
CreationContext
Attributs
creator object
Requis
expectedPrice number
Creator
Attributs
groupId number
userId number
ModerationResult
Attributs
moderationState string
Operation
Attributs
done boolean
error object
metadata object
path string
response object
Preview
Attributs
altText string
asset string
SocialLink
Attributs
title string
uri string
State
Attributs
string (enum): "Unspecified", "Active", "Archived"
Status
Attributs
code number
details array<object>
message string