Assets-API
*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.
Du kannst die folgenden Anforderungs- und Antwort-Payloads senden und empfangen, um Assets auf Roblox zu erstellen.Für Informationen über die Verwendung der API siehe den Verwendungsleitfaden.
Assets
Asset-Versionen listen
Liste alle Versionen eines bestimmten Objektmit optionaler Seiten navigation.
Parameter
Die eindeutige Kennung des Objekt.
Gibt die Anzahl der Asset-Versionen an, die in der Antwort enthalten sein sollen. Gültige Werte reichen von 1 bis 50 (einschließlich). Standard ist 8, wenn nicht bereitgestellt.
Ein Token für die Seitenzählung. Der Wert wird aus einer vorherigen Anfrage abgeleitet und ermöglicht das Abrufen der nächsten Seite der Asset-Versionen.
Anfrage
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.
Limits
Pro API-Schlüssel: 100 Anfoderungen pro 60 Sekunden pro IP-Adresse
Rückgängigkeits-Asset-Version
Rolle ein Asset auf eine bestimmte frühere Version zurück.
Geben Sie den Asset-Version-Pfad in den Formdaten an.
Parameter
Die eindeutige Kennung des Objekt.
Anfrage
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.
Limits
Pro API-Schlüssel: 100 Anfoderungen pro 60 Sekunden pro IP-Adresse
Ressource erstellen
Erstellt ein Asset mit angegebenem Inhalt und Metadaten.
Du kannst keine SocialLink-Objekte hinzufügen, wenn du ein Asset erstellst. Stattdessen verwende Asset aktualisieren.
Geben Sie die Assets, binäre Asset-Dateipfad, und Inhaltstyp in den Formdaten an.
Anfrage
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
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.
Limits
Pro API-Schlüssel: 60 Anfoderungen pro 60 Sekunden pro IP-Adresse
Asset erhalten
Rufe spezifischen Asset-Inhalt und Metadaten ab.
Parameter
Die eindeutige Kennung des Objekt.
Asset-Metadatenfelder zum abrufen, einschließlich der Beschreibung, des Anzeigename, des Symbols, der sozialen Links und der Vorschau. Beispiele: description%2CdisplayName , previews%2CtwitchSocialLink .
Anfrage
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \
--header 'x-api-key: {apiKey}'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.
Limits
Pro API-Schlüssel: 60 Anfoderungen pro 60 Sekunden pro IP-Adresse
Asset aktualisieren
Aktualisiert ein Asset mit bereitgestelltem Inhalt und Metadaten, einschließlich der Beschreibung, des Anzeigennamens, des Symbols, der sozialen Links und der Vorschauen.Derzeit kann nur der Inhaltskörper für Modelle aktualisiert werden.Icons und Vorschau müssen Bild -Assets sein.Icons müssen quadratische Dimensionen haben.
Geben Sie die Assets, binäre Asset-Dateipfad, und Inhaltstyp in den Formdaten an.
Parameter
Die eindeutige Kennung des Objekt.
Asset-Metadatenfelder zum Update, einschließlich Beschreibung, Display-Name, Symbolund Vorschau. Beispiele: description%2CdisplayName , previews%2CtwitchSocialLink .
Anfrage
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}\""'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}\"'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.\"}]}"'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ü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.
Limits
Pro API-Schlüssel: 60 Anfoderungen pro 60 Sekunden pro IP-Adresse
Abrufe die Asset-Version
Rufe eine bestimmte Asset-Version durch die Asset-ID und die Versionsnummer ab.
Parameter
Die eindeutige Kennung des Objekt.
Die Versionsnummer.
Anfrage
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.
Limits
Pro API-Schlüssel: 100 Anfoderungen pro 60 Sekunden pro IP-Adresse
Archiv-Asset
Archiviert das Asset.Archivierte Assets verschwinden von der Website und sind nicht mehr nutzbar oder sichtbar in Roblox-Erlebnissen, aber du kannst sie wiederherstellen.
Parameter
Die eindeutige Kennung des Objekt.
Anfrage
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'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.
Limits
Pro API-Schlüssel: 100 Anfoderungen pro 60 Sekunden pro IP-Adresse
Asset wiederherstellen
Stellt ein archiviertes Objektwieder her.
Parameter
Die eindeutige Kennung des Objekt.
Anfrage
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'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.
Limits
Pro API-Schlüssel: 100 Anfoderungen pro 60 Sekunden pro IP-Adresse
Operation erhalten
Erhalte das Ergebnis einer Asset-Erstellung oder -Aktualisierung mit der zurückgegebenen Operation-ID.Erfordert Lesen für die API-Schlüsselberechtigung und Objekt:lesen für OAuth 2.0-Apps.
Parameter
Die eindeutige Kennung der Operation.
Anfrage
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--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.
Limits
Pro API-Schlüssel: 100 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 zufällige serisierte Nachricht zusammen mit einer @type, die die Art der serisierten Nachricht beschreibt.
Attribute
Die Art der serisierten Nachricht.
Asset
Repräsentiert ein Objekt.
Attribute
Die eindeutige Kennung des Objekt. Erforderlich für Asset aktualisieren.
Der eingeben. Kann nur Audio , Decal oder Model sein. Erforderlich für Asset erstellen .
Der Kontext der Erstellung, der nicht Teil des Asset-Inhalts ist, wie z. B. Metadaten und Erstellerinformationen. Erforderlich für Asset erstellen.
Die Beschreibung des Objekt. Beschränken Sie sich auf 1000 Zeichen. Erforderlich für Asset erstellen.
Anzeigename des Objekt. Erforderlich für Asset erstellen.
Der Ressourcenpfad für das Symbol.
Das Moderationsergebnis des Objekt.
Der zurückgegebene Ressourcenpfad des Objekt. Format: assets/{assetId} . Beispiel: assets/2205400862 .
Eine Liste von Vorschauen, jede mit einem Asset-Pfad und alternativen Text. Vorschauen müssen Bild -Assets sein.
Der Erstellungszeitpunkt der aktuellen Revision.
Überarbeitungs-ID des Objekt.Äquivalent zu versionNumber.Jede Änderung des Assets kommt automatisch eine neue Version zu.Das Format ist eine String.Beispiel: 1.
Ein Social-Media-Link für das Asset.Maximal drei pro Asset.Der Objektname kann eine von folgenden sein:
- facebookSocialLink
- twitterSocialLink
- youtubeSocialLink
- twitchSocialLink
- discordSocialLink
- githubSocialLink
- robloxSocialLink
- guildedSocialLink
- devForumSocialLink
Ob das Asset aktiv oder archiviert ist. Unspezifiziert wird nicht verwendet.
AssetVersion
Eine Asset-Version.
Attribute
Der Kontext der Erstellung, der nicht Teil des Asset-Inhalts ist, wie z. B. Metadaten und Erstellerinformationen. Erforderlich für Asset erstellen.
Das Moderationsergebnis des Objekt.
Der zurückgegebene Ressourcenpfad der Asset-Version. Format: assets/{assetId}/versions/{version} . Beispiel: assets/2205400862/versions/1 .
CreationContext
Der Kontext der Erstellung, der nicht Teil des Asset-Inhalts ist, wie z. B. Metadaten und Erstellerinformationen. Erforderlich für Asset erstellen.
Attribute
Repräsentiert einen Creator:in.
Erwartete Asset-Upload-Gebühr in Robux. Wenn der tatsächliche Preis mehr als erwartet ist, scheitert die Operation mit einem 400-Fehler.
Creator
Repräsentiert einen Creator:in.
Attribute
Die Gruppen-ID. Erforderlich, wenn das Asset gruppeneigen ist.
Die Benutzer-ID des Creator:in. Erforderlich, wenn das Asset einzelnen Benutzern gehört.
ModerationResult
Das Moderationsergebnis des Objekt.
Attribute
Der Moderationszustand des Objekt. Kann Reviewing , Rejected oder Approved sein.
Operation
Diese Ressource repräsentiert eine lange laufende Operation, die das Ergebnis eines Netzwerk-API-Aufrufs ist.
Attribute
Wenn false , ist die Operation noch im Gange. Wenn true , ist die Operation abgeschlossen.
Das logische Fehlermodell, das den Statuserklärt.
Enthält eine zufällige serisierte Nachricht zusammen mit einer @type, die die Art der serisierten Nachricht beschreibt.
Der vom Server zugewiesene Ressourcenpfad. Das Standardformat ist operations/{operation_id} .
Enthält eine zufällige serisierte Nachricht zusammen mit einer @type, die die Art der serisierten Nachricht beschreibt.
Preview
Eine Asset-Vorschau.
Attribute
Alternativer Text für das Objekt.
Der Vorschau-Asset-Pfad.
SocialLink
Ein Social-Media-Link für das Asset.Maximal drei pro Asset.Der Objektname kann eine von folgenden sein:
- facebookSocialLink
- twitterSocialLink
- youtubeSocialLink
- twitchSocialLink
- discordSocialLink
- githubSocialLink
- robloxSocialLink
- guildedSocialLink
- devForumSocialLink
Attribute
Ein optioneller Titel für den verlinken. Wird nicht auf dem Creator-Hub verwendet.
Die URI für den verlinken.Muss dem erwarteten Format für die Art des verlinkenentsprechen.Zum Beispiel muss der Titel für ein twitchSocialLink Objekt im Format https://twitch.tv/your-channel sein.
State
Ob das Asset aktiv oder archiviert ist. Unspezifiziert wird nicht verwendet.
Attribute
Status
Das logische Fehlermodell, das den Statuserklärt.
Attribute
Der Codes.
Eine Liste von Nachrichten mit Fehler details.
Die Nachricht.