Assets API

Assets

https://apis.roblox.com/assets

Get Asset

GET /v1/assets

Paramètres

assetId Asset
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

Create Asset

POST /v1/assets

Paramètres

request Asset
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
Returns the Operation ID for checking the creation status.
Renvoie une object: Operation
path string
metadata Any
done boolean
error Status
response Any

Autorisations requises

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

Limitations

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

Update Asset

PATCH /v1/assets/{assetId}

Paramètres

request Asset
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
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.\"}]}"'

Réponse

200 - OK
Returns the Operation ID for checking the update status / Returns the updated metadata fields.
Renvoie une object: Operation
path string
metadata Any
done boolean
error Status
response Any

Autorisations requises

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

Limitations

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

Get Asset Version

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

List Asset Versions

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
  • Écrire
  • asset:read
  • asset:write

Limitations

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

Rollback Asset Version

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

Get Operation

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: Operation
path string
metadata Any
done boolean
error Status
response Any

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
Requis

Asset

Attributs

assetType string
Requis
assetId number
Requis
creationContext CreationContext
Requis
description string
Requis
displayName string
Requis
path string
Requis
revisionId string
Requis
revisionCreateTime string
Requis
moderationResult ModerationResult
Requis
icon string
Requis
previews array<Preview>
Requis

CreationContext

Attributs

creator Creator
Requis
expectedPrice number
Requis

Creator

Attributs

userId number
Requis
groupId number
Requis

ModerationResult

Attributs

moderationState string
Requis

Operation

Attributs

path string
Requis
metadata Any
Requis
done boolean
Requis
error Status
Requis
response Any
Requis

Preview

Attributs

asset string
Requis
altText string
Requis

Status

Attributs

code number
Requis
message string
Requis
details array<Any>
Requis