Assets-API

*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.

Assets

https://apis.roblox.com/assets

Asset-Versionen anzeigen

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

Parameter

assetId string
Path
Erforderlich
maxPageSize number
pageToken string

Anfrage

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

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

Rückmeldung

Erforderliche Berechtigungen

  • Lesen
  • asset:read

Limits

Pro API-Schlüssel: 60 Anfoderungen pro 60 Sekunden pro IP-Adresse

Rollback-Asset-Version

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

Parameter

assetId string
Path
Erforderlich
assetVersion string
FormData
Erforderlich

Anfrage

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ückmeldung

Erforderliche Berechtigungen

  • Lesen
  • Schreiben
  • asset:read
  • asset:write

Limits

Pro API-Schlüssel: 60 Anfoderungen pro 60 Sekunden pro IP-Adresse

Asset erhalten

GET /v1/assets

Parameter

assetId
Path
Erforderlich
readMask string

Anfrage

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ückmeldung

Erforderliche Berechtigungen

  • Lesen
  • asset:read

Limits

Pro API-Schlüssel: 60 Anfoderungen pro 60 Sekunden pro IP-Adresse

Asset erstellen

POST /v1/assets

Parameter

request
FormData
Erforderlich
fileContent string
FormData
Erforderlich

Anfrage

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ückmeldung

200 - OK
Rückgibt die Operation-ID, um den Statusder Erstellung zu überprüfen.
Gibt zurück ein(e) object
done boolean
error object
metadata object
path string
response object

Erforderliche Berechtigungen

  • Lesen
  • Schreiben
  • asset:read
  • asset:write

Limits

Pro API-Schlüssel: 60 Anfoderungen pro 60 Sekunden pro IP-Adresse

Asset aktualisieren

PATCH /v1/assets/{assetId}

Parameter

request
FormData
Erforderlich
fileContent string
FormData
updateMask string

Anfrage

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ückmeldung

200 - OK
Gibt die Operation-ID zurück, um den Status des Updates zu überprüfen / gibt die aktualisierten Metadaten-Felder zurück.
Gibt zurück ein(e) 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

Erforderliche Berechtigungen

  • Lesen
  • Schreiben
  • asset:read
  • asset:write

Limits

Pro API-Schlüssel: 60 Anfoderungen pro 60 Sekunden pro IP-Adresse

Asset-Version abrufen

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

Parameter

assetId string
Path
Erforderlich
versionNumber string
Path
Erforderlich

Anfrage

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

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

Rückmeldung

Erforderliche Berechtigungen

  • Lesen
  • asset:read

Limits

Pro API-Schlüssel: 60 Anfoderungen pro 60 Sekunden pro IP-Adresse

Operation erhalten

GET /v1/operations/{operationId}

Anfrage

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

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

Rückmeldung

200 - OK
Gibt zurück ein(e) object
done boolean
error object
metadata object
path string
response object

Erforderliche Berechtigungen

  • Lesen
  • asset:read

Limits

Pro API-Schlüssel: 60 Anfoderungen pro 60 Sekunden pro IP-Adresse

Objekte

Die folgenden Objekte beschreiben Nutzlasten, die akzeptiert oder zurückgegeben werden. Die einzelnen Endpunkte zeigen weitere Informationen darüber an, wann diese Objekte verwendet werden.

Any

Attribute

@type string

Asset

Attribute

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

Attribute

creator object
Erforderlich
expectedPrice number

Creator

Attribute

groupId number
userId number

ModerationResult

Attribute

moderationState string

Operation

Attribute

done boolean
error object
metadata object
path string
response object

Preview

Attribute

altText string
asset string

Attribute

title string
uri string

Status

Attribute

code number
details array<object>
message string