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

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

Autorisations requises

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

Paramètres

assetId string
Path
Requis
assetVersion string
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

  • Lire
  • Écrire
  • asset:read
  • asset:write

Limitations

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

Obtenir ressource

GET /v1/assets

Paramètres

assetId
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

Autorisations requises

  • Lire
  • asset:read

Limitations

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

Créer un élément

POST /v1/assets

Paramètres

request
FormData
Requis
fileContent string
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
error object
metadata object
path string
response object

Autorisations requises

  • Lire
  • Écrire
  • 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}

Paramètres

request
FormData
Requis
fileContent string
FormData
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

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
error object
metadata object
path string
response object

Autorisations requises

  • Lire
  • Écrire
  • 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}

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

Autorisations requises

  • Lire
  • asset:read

Limitations

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

Obtenez l'opération

GET /v1/operations/{operationId}

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
error object
metadata object
path string
response object

Autorisations requises

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

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

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

Attributs

title string
uri string

Status

Attributs

code number
details array<object>
message string