Assets-API

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

Sie können die folgenden Anfrage- und Antwort-Payloads senden und empfangen, um Assets auf Roblox zu erstellen. Für Informationen zum Gebrauch der API, siehe den Benutzerhandbuch.

Assets

https://apis.roblox.com/assets

Asset-Versionen anzeigen

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

Liste alle Versionen eines bestimmten Objektmit optionalem pagination.

Parameter

assetId string

Die eindeutige Kennung des Objekt.

Path
Erforderlich
maxPageSize number

Gibt die Anzahl der Asset-Versionen an, die in der Antwort enthalten sein sollen. Gültige Werte reichen von 1 bis 50 (einschließlich). Standardwerte für 8, wenn nicht angegeben.

pageToken string

Ein Token für die Navigation. Der Wert wird aus einer früheren Anfrage erhalten und ermöglicht es, die nächste Seite der Asset-Versionen abzurufen.

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

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Lesen

Um diesen Endpunkt nutzen zu können, werden folgende Anwendungsbereiche für deine OAuth 2.0 App benötigt. Weitere Informationen zur Registrierung einer OAuth 2.0-App findest du unter App Registration and Review.

  • 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

Rollen Sie ein Asset zu einer bestimmten früheren Version zurück.

Parameter

assetId string

Die eindeutige Kennung des Objekt.

Path
Erforderlich
assetVersion string

Die Asset-Versions-Pfad im Format von assets/{assetId}/versions/{versionNumber} .

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

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Lesen

  • Schreiben

Um diesen Endpunkt nutzen zu können, werden folgende Anwendungsbereiche für deine OAuth 2.0 App benötigt. Weitere Informationen zur Registrierung einer OAuth 2.0-App findest du unter App Registration and Review.

  • asset:read

  • asset:write

Limits

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

Asset erhalten

GET /v1/assets

Beschaffe spezifischen Inhalt und Metadaten.

Parameter

assetId

Die eindeutige Kennung des Objekt.

Path
Erforderlich
readMask string

Asset-Metadatenfelder zum abrufen, einschließlich der Beschreibung, des Anzeigennamens, des Icons, der sozialen Links und der Vorschau. Beispiele: description%2CdisplayName , previews%2CtwitchSocialLink .

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

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Lesen

Um diesen Endpunkt nutzen zu können, werden folgende Anwendungsbereiche für deine OAuth 2.0 App benötigt. Weitere Informationen zur Registrierung einer OAuth 2.0-App findest du unter App Registration and Review.

  • asset:read

Limits

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

Asset erstellen

POST /v1/assets

Erstellt ein Asset mit bereitgestelltem Inhalt und Metadaten.

Du kannst keine SocialLink-Objekte hinzufügen wenn du ein Asset erstellst. Stattdessen verwende Asset-Update-Formular.

Parameter

request

Asset-Attributs zum Erstellen oder Update. Senden Sie als Form-Daten wie die folgende Beispielanfrage.

FormData
Erforderlich
fileContent string

Die binäre Asset-Datei-Pfad und den eingeben. Format: fileContent=@"/filepath/{File}";type={ContentType} . Beispiel: fileContent=@"/feather/model.fbx"; Art = model/羽毛 . Siehe Inhaltsarten .

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

Wenn false , die Operation ist immer noch in Gange. Wenn true , die Operation ist abgeschlossen.

error object

Das logische Fehlermodell, das den Statuserklärt.

metadata object

Enthält eine beliebige serialisierte Nachricht zusammen mit einem @type, das die Art der serialisierten Nachricht beschreibt.

path string

Der zugewiesene Ressourcen-Weg. Die Standard format ist operations/{operation_id} .

response object

Enthält eine beliebige serialisierte Nachricht zusammen mit einem @type, das die Art der serialisierten Nachricht beschreibt.

Erforderliche Berechtigungen

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Lesen

  • Schreiben

Um diesen Endpunkt nutzen zu können, werden folgende Anwendungsbereiche für deine OAuth 2.0 App benötigt. Weitere Informationen zur Registrierung einer OAuth 2.0-App findest du unter App Registration and Review.

  • asset:read

  • asset:write

Limits

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

Asset aktualisieren

PATCH /v1/assets/{assetId}

Aktualisiert eine Asset mit bereitgestelltem Inhalt und Metadaten, einschließlich der Beschreibung, des Anzeigename, des Icons, der sozialen Links und der Vorschau. Derzeit kann nur den Inhaltskörper für Modelle aktualisieren. Icons und Vorschau müssen Bild Assets sein. Icons müssen quadratische Dimensionen haben.

Parameter

request

Senden Sie als Formulardaten wie die folgenden Beispielanfragen.

FormData
Erforderlich
fileContent string

Die binäre Asset-Datei-Pfad und den eingeben. Format: fileContent=@"/filepath/{File}";type={ContentType} . Beispiel: fileContent=@"/feather/model.fbx"; Art = model/羽毛 . Siehe Inhaltsarten .

FormData
updateMask string

Asset-Metadatenfelder zu Update, einschließlich der Beschreibung, des Anzeigename, des Icons und der Vorschau. Beispiele: description%2CdisplayName , previews%2CtwitchSocialLink .

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

Wenn false , die Operation ist immer noch in Gange. Wenn true , die Operation ist abgeschlossen.

error object

Das logische Fehlermodell, das den Statuserklärt.

metadata object

Enthält eine beliebige serialisierte Nachricht zusammen mit einem @type, das die Art der serialisierten Nachricht beschreibt.

path string

Der zugewiesene Ressourcen-Weg. Die Standard format ist operations/{operation_id} .

response object

Enthält eine beliebige serialisierte Nachricht zusammen mit einem @type, das die Art der serialisierten Nachricht beschreibt.

Erforderliche Berechtigungen

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Lesen

  • Schreiben

Um diesen Endpunkt nutzen zu können, werden folgende Anwendungsbereiche für deine OAuth 2.0 App benötigt. Weitere Informationen zur Registrierung einer OAuth 2.0-App findest du unter App Registration and Review.

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

Beschaffe eine bestimmte Asset-Version durch die Asset-ID und die Versionsnummer.

Parameter

assetId string

Die eindeutige Kennung des Objekt.

Path
Erforderlich
versionNumber string

Die Versionsnummer.

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

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Lesen

Um diesen Endpunkt nutzen zu können, werden folgende Anwendungsbereiche für deine OAuth 2.0 App benötigt. Weitere Informationen zur Registrierung einer OAuth 2.0-App findest du unter App Registration and Review.

  • asset:read

Limits

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

Operation erhalten

GET /v1/operations/{operationId}

Erhalte das Ergebnis einer Asset-Erstellung oder eines Updates mit der zurückgegebenen Operation-ID. Benötigt Lesen für die API-Schlüsselberechtigung und Objekt:read für OAuth 2.0-Apps.

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

Wenn false , die Operation ist immer noch in Gange. Wenn true , die Operation ist abgeschlossen.

error object

Das logische Fehlermodell, das den Statuserklärt.

metadata object

Enthält eine beliebige serialisierte Nachricht zusammen mit einem @type, das die Art der serialisierten Nachricht beschreibt.

path string

Der zugewiesene Ressourcen-Weg. Die Standard format ist operations/{operation_id} .

response object

Enthält eine beliebige serialisierte Nachricht zusammen mit einem @type, das die Art der serialisierten Nachricht beschreibt.

Erforderliche Berechtigungen

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Lesen

Um diesen Endpunkt nutzen zu können, werden folgende Anwendungsbereiche für deine OAuth 2.0 App benötigt. Weitere Informationen zur Registrierung einer OAuth 2.0-App findest du unter App Registration and Review.

  • 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

Enthält eine beliebige serialisierte Nachricht zusammen mit einem @type, das die Art der serialisierten Nachricht beschreibt.

Attribute

@type string

Die Art der serialisierten Nachricht.

Asset

Repäsentiert eine Objekt.

Attribute

assetId number

Die einzigartige Kennung des Objekt. Erforderlich für Asset-Update .

assetType string

Der eingeben. Kann nur Audio , Decal oder Model sein. Benötigt für 2> Asset erstellen2> .

creationContext object

Der Kontext der Erstellung, der nicht Teil des Asset-Inhalts ist, wie Metadaten und Schöpfer-Informationen. Benötigt für Asset erstellen .

description string

Die Beschreibung des Objekt. Limit 1000 Zeichen. Erforderlich für Asset erstellen .

displayName string

Name des Objektanzeigen. Benötigt für Asset erstellen .

icon string

Der Ressourcen-Weg für das Symbol.

moderationResult object

Das Moderationsergebnis des Objekt.

path string

Die zurückgegebene Ressourcen-ID des Objekt. Format: assets/{assetId} . Beispiel: assets/2205400862 .

previews array<object>

Eine Liste von Vorschauen, jede mit einem Asset-Weg und einem Alt-Text. Vorschauen müssen Bild -Assets sein.

revisionCreateTime string

Der Zeitpunkt der Erstellung der aktuellen Revision.

revisionId string

Revision-ID des Objekt. Äquivalent zu versionNumber. Jeder Änderung des Assets wird automatisch eine neue Version zugewiesen. Die Form ist eine String. Beispiel: 1 .

socialLink object

Ein Social-Media-Link für das Asset. Maximal drei pro Asset. Objektname kann beliebig sein:

CreationContext

Der Kontext der Erstellung, der nicht Teil des Asset-Inhalts ist, wie Metadaten und Schöpfer-Informationen. Benötigt für Asset erstellen .

Attribute

creator object

Repräsentiert einen Creator:in.

Erforderlich
expectedPrice number

Robux-Asset-Upload-Gebühr erwartet. Wenn der tatsächliche Preis mehr als erwartet ist, fehlgeschlagen die Operation mit einem 400-Fehler.

Creator

Repräsentiert einen Creator:in.

Attribute

groupId number

Die Gruppen-ID. Benötigt, wenn das Asset einer Gruppe gehört.

userId number

Die Benutzer-ID des Creator:in. Benötigt, wenn das Asset einzeln besessen wird.

ModerationResult

Das Moderationsergebnis des Objekt.

Attribute

moderationState string

Der Moderationszustand des Objekt. Kann MODERATION_STATE_REVIEWING , MODERATION_STATE_REJECTED oder MODERATION_STATE_APPROVED sein.

Operation

Diese Ressource stellt eine lange laufende Operation dar, die das Ergebnis einer Netzwerk-API-Anrufe ist.

Attribute

done boolean

Wenn false , die Operation ist immer noch in Gange. Wenn true , die Operation ist abgeschlossen.

error object

Das logische Fehlermodell, das den Statuserklärt.

metadata object

Enthält eine beliebige serialisierte Nachricht zusammen mit einem @type, das die Art der serialisierten Nachricht beschreibt.

path string

Der zugewiesene Ressourcen-Weg. Die Standard format ist operations/{operation_id} .

response object

Enthält eine beliebige serialisierte Nachricht zusammen mit einem @type, das die Art der serialisierten Nachricht beschreibt.

Preview

Ein Asset-Vorschau.

Attribute

altText string

Alt-Text für das Objekt.

asset string

Der Vorschau-Asset-Weg.

Ein Social-Media-Link für das Asset. Maximal drei pro Asset. Objektname kann beliebig sein:

Attribute

title string

Ein optionale Titel für den verlinken. Wird nicht im Creator-Hub verwendet.

uri string

Die URL für den verlinken. Muss das erwartete Format für die Art des verlinkenentsprechen. Zum Beispiel muss der Titel für ein twitchSocialLink-Objekt aus der folgenden Liste sein:

Status

Das logische Fehlermodell, das den Statuserklärt.

Attribute

code number

Der Codes.

details array<object>

Eine Liste von Nachrichten, die Fehler Details enthalten.

message string

Die Fehler-Nachricht.