API Aset

*Konten ini diterjemahkan menggunakan AI (Beta) dan mungkin mengandung kesalahan. Untuk melihat halaman ini dalam bahasa Inggris, klik di sini.

Anda dapat mengirim dan menerima permintaan dan respons berikut untuk membuat aset di Roblox.Untuk informasi tentang penggunaan API, lihat panduan penggunaan .

Assets

https://apis.roblox.com/assets

Daftar Versi Aset

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

Daftar semua versi dari aset tertentu, dengan pengurutan opsional.

Parameter

assetId string

Pengenal unik dari aset.

Path
Diperlukan
maxPageSize number

Menentukan jumlah versi aset yang harus dimasukkan dalam respons. Nilai yang valid berkisar dari 1 hingga 50 (termasuk). Nilai default adalah 8 saat tidak disediakan.

pageToken string

Token untuk pengurutan. Nilainya diperoleh dari permintaan sebelumnya dan memungkinkan untuk mengambil halaman berikutnya dari versi aset.

Permintaan

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

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

Respons

200 - OK
Versi aset terdaftar dengan sukses.
Memberikan nilai array<object>

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Baca

Batas

Per Kunci API: 100 permintaan setiap 60 detik per Alamat IP

Versi Aset Rollback

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

Putar ulang aset ke versi sebelumnya tertentu.

Berikan jalur versi aset dalam data formulir.

Parameter

assetId string

Pengenal unik dari aset.

Path
Diperlukan

Permintaan

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}\"}'

Respons

200 - OK
Aset dibalikkan dengan sukses.
Memberikan nilai object
creationContext object

Konteks penciptaan yang bukan bagian dari konten aset, seperti metadata dan informasi pencipta. Diperlukan untuk Buat Asset .

moderationResult object

Hasil moderasi dari aset.

path string

Jalur sumber daya yang dikembalikan dari versi aset. Format: assets/{assetId}/versions/{version} . Contoh: assets/2205400862/versions/1 .

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Baca

  • Tulis

Batas

Per Kunci API: 100 permintaan setiap 60 detik per Alamat IP

Buat Aset

POST /v1/assets

Membuat aset dengan konten dan metadata yang disediakan.

Anda tidak dapat menambahkan objek Tautan Sosial saat membuat aset. Sebagai gantinya, gunakan Perbarui Asset.

Berikan Aset , jalur file aset binari, dan jenis konten di data formulir.

Permintaan

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'

Respons

200 - OK
Kembalikan ID Operasi untuk memeriksa status pembuatan.
Memberikan nilai object
done boolean

Jika false , operasi masih dalam progres. Jika true , operasi selesai.

error object

Model kesalahan logis yang menjelaskan status kesalahan.

metadata object

Berisi pesan berurutan acak bersama dengan @type yang menggambarkan jenis pesan berurutan.

path string

Jalur sumber daya yang ditugaskan oleh server. Format default adalah operations/{operation_id} .

response object

Berisi pesan berurutan acak bersama dengan @type yang menggambarkan jenis pesan berurutan.

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Baca

  • Tulis

Batas

Per Kunci API: 60 permintaan setiap 60 detik per Alamat IP

Dapatkan Aset

GET /v1/assets/{assetId}

Ambil konten aset dan metadata spesifik.

Parameter

assetId string

Pengenal unik dari aset.

Path
Diperlukan
readMask string

Bidang metadata aset untuk diambil, termasuk deskripsi, nama display, ikon, tautan sosial, dan pratinjau. Contoh: description%2CdisplayName , previews%2CtwitchSocialLink .

Permintaan

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

Respons

200 - OK
Sumber daya aset diambil dengan sukses.
Memberikan nilai object
assetId number

Pengenal unik dari aset. Diperlukan untuk Update Asset.

assetType string

ketikaset. Hanya bisa Audio , Decal , atau Model . Diperlukan untuk Buat Aset .

creationContext object

Konteks penciptaan yang bukan bagian dari konten aset, seperti metadata dan informasi pencipta. Diperlukan untuk Buat Asset .

description string

Deskripsi aset. Batasi hingga 1000 karakter. Diperlukan untuk Buat Aset .

displayName string

Nama tampilan dari aset. Diperlukan untuk Buat Aset.

icon string

Jalur sumber daya untuk ikon.

moderationResult object

Hasil moderasi dari aset.

path string

Jalur sumber daya yang dikembalikan dari aset. Format: assets/{assetId} . Contoh: assets/2205400862 .

previews array<object>

Daftar pratinjau, masing-masing dengan jalur aset dan teks alternatif. Pratinjau harus menjadi Gambar aset.

revisionCreateTime string

timestamp penciptaan revisi saat ini.

revisionId string

ID revisi dari aset.Setara dengan versionNumber .Setiap perubahan aset secara otomatis melakukan komitmen versi baru.Format adalah string bilangan bulat.Contoh: 1 .

socialLink object

Tautan media sosial untuk aset.Maksimum tiga per aset.Nama objek bisa menjadi salah satu dari:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
Untuk sintaks, lihat permintaan contoh di bawah Update Asset .

state string

Apakah aset aktif atau diarsipkan. Tidak ditentukan tidak digunakan.

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Baca

Batas

Per Kunci API: 60 permintaan setiap 60 detik per Alamat IP

Perbarui Aset

PATCH /v1/assets/{assetId}

Memperbarui aset dengan konten dan metadata yang disediakan, termasuk deskripsi, nama display, ikon, tautan sosial, dan pratinjau.Saat ini hanya dapat memperbarui tubuh konten untuk Model .Ikon dan Pratinjau harus menjadi Gambar aset.Ikon harus memiliki dimensi kotak.

Berikan Aset , jalur file aset binari, dan jenis konten di data formulir.

Parameter

assetId string

Pengenal unik dari aset.

Path
Diperlukan
updateMask string

Bidang metadata aset untuk update, termasuk deskripsi, nama display, ikon, dan pratinjau. Contoh: description%2CdisplayName , previews%2CtwitchSocialLink .

Permintaan

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

Respons

200 - OK
Kembalikan ID Operasi untuk memeriksa status pembaruan / Kembalikan bidang metadata yang diperbarui.
Memberikan nilai object
application/json
{"previews": [

  {"asset": "assets/123", "altText": "preview 1"},

  {"asset": "assets/456", "altText": "preview 2"}

]}
done boolean

Jika false , operasi masih dalam progres. Jika true , operasi selesai.

error object

Model kesalahan logis yang menjelaskan status kesalahan.

metadata object

Berisi pesan berurutan acak bersama dengan @type yang menggambarkan jenis pesan berurutan.

path string

Jalur sumber daya yang ditugaskan oleh server. Format default adalah operations/{operation_id} .

response object

Berisi pesan berurutan acak bersama dengan @type yang menggambarkan jenis pesan berurutan.

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Baca

  • Tulis

Batas

Per Kunci API: 60 permintaan setiap 60 detik per Alamat IP

Dapatkan Versi Aset

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

Ambil versi aset tertentu dengan ID aset dan nomor versi.

Parameter

assetId string

Pengenal unik dari aset.

Path
Diperlukan
versionNumber string

Angka nomor versi.

Path
Diperlukan

Permintaan

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

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

Respons

200 - OK
Versi aset diambil dengan sukses.
Memberikan nilai object
creationContext object

Konteks penciptaan yang bukan bagian dari konten aset, seperti metadata dan informasi pencipta. Diperlukan untuk Buat Asset .

moderationResult object

Hasil moderasi dari aset.

path string

Jalur sumber daya yang dikembalikan dari versi aset. Format: assets/{assetId}/versions/{version} . Contoh: assets/2205400862/versions/1 .

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Baca

Batas

Per Kunci API: 100 permintaan setiap 60 detik per Alamat IP

Aset Arsip

POST /v1/assets/{assetId}:archive

Menyimpan aset.Aset terarsip menghilang dari situs web dan tidak lagi dapat digunakan atau terlihat di pengalaman Roblox, tetapi Anda dapat memulihkan mereka.

Parameter

assetId string

Pengenal unik dari aset.

Path
Diperlukan

Permintaan

Archive Asset
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \

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

--header 'Content-Type: application/json'

Respons

200 - OK
Aset disimpan dengan sukses dengan sukses.
Memberikan nilai object
assetId number

Pengenal unik dari aset. Diperlukan untuk Update Asset.

assetType string

ketikaset. Hanya bisa Audio , Decal , atau Model . Diperlukan untuk Buat Aset .

creationContext object

Konteks penciptaan yang bukan bagian dari konten aset, seperti metadata dan informasi pencipta. Diperlukan untuk Buat Asset .

description string

Deskripsi aset. Batasi hingga 1000 karakter. Diperlukan untuk Buat Aset .

displayName string

Nama tampilan dari aset. Diperlukan untuk Buat Aset.

icon string

Jalur sumber daya untuk ikon.

moderationResult object

Hasil moderasi dari aset.

path string

Jalur sumber daya yang dikembalikan dari aset. Format: assets/{assetId} . Contoh: assets/2205400862 .

previews array<object>

Daftar pratinjau, masing-masing dengan jalur aset dan teks alternatif. Pratinjau harus menjadi Gambar aset.

revisionCreateTime string

timestamp penciptaan revisi saat ini.

revisionId string

ID revisi dari aset.Setara dengan versionNumber .Setiap perubahan aset secara otomatis melakukan komitmen versi baru.Format adalah string bilangan bulat.Contoh: 1 .

socialLink object

Tautan media sosial untuk aset.Maksimum tiga per aset.Nama objek bisa menjadi salah satu dari:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
Untuk sintaks, lihat permintaan contoh di bawah Update Asset .

state string

Apakah aset aktif atau diarsipkan. Tidak ditentukan tidak digunakan.

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Baca

  • Tulis

Batas

Per Kunci API: 100 permintaan setiap 60 detik per Alamat IP

Restorasi Aset

POST /v1/assets/{assetId}:restore

Memulihkan aset tersimpan.

Parameter

assetId string

Pengenal unik dari aset.

Path
Diperlukan

Permintaan

Restore Asset
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \

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

--header 'Content-Type: application/json'

Respons

200 - OK
Aset dipulihkan dengan sukses.
Memberikan nilai object
assetId number

Pengenal unik dari aset. Diperlukan untuk Update Asset.

assetType string

ketikaset. Hanya bisa Audio , Decal , atau Model . Diperlukan untuk Buat Aset .

creationContext object

Konteks penciptaan yang bukan bagian dari konten aset, seperti metadata dan informasi pencipta. Diperlukan untuk Buat Asset .

description string

Deskripsi aset. Batasi hingga 1000 karakter. Diperlukan untuk Buat Aset .

displayName string

Nama tampilan dari aset. Diperlukan untuk Buat Aset.

icon string

Jalur sumber daya untuk ikon.

moderationResult object

Hasil moderasi dari aset.

path string

Jalur sumber daya yang dikembalikan dari aset. Format: assets/{assetId} . Contoh: assets/2205400862 .

previews array<object>

Daftar pratinjau, masing-masing dengan jalur aset dan teks alternatif. Pratinjau harus menjadi Gambar aset.

revisionCreateTime string

timestamp penciptaan revisi saat ini.

revisionId string

ID revisi dari aset.Setara dengan versionNumber .Setiap perubahan aset secara otomatis melakukan komitmen versi baru.Format adalah string bilangan bulat.Contoh: 1 .

socialLink object

Tautan media sosial untuk aset.Maksimum tiga per aset.Nama objek bisa menjadi salah satu dari:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
Untuk sintaks, lihat permintaan contoh di bawah Update Asset .

state string

Apakah aset aktif atau diarsipkan. Tidak ditentukan tidak digunakan.

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Baca

  • Tulis

Batas

Per Kunci API: 100 permintaan setiap 60 detik per Alamat IP

Dapatkan Operasi

GET /v1/operations/{operationId}

Dapatkan hasil pembuatan atau pembaruan aset menggunakan ID Operasi yang dikembalikan.Membutuhkan Membaca untuk izin kunci API dan aset:read untuk aplikasi OAuth 2.0.

Parameter

operationId string

Pengenal unik dari operasi.

Path
Diperlukan

Permintaan

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

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

Respons

200 - OK
Hasil operasi diambil dengan sukses.
Memberikan nilai object
done boolean

Jika false , operasi masih dalam progres. Jika true , operasi selesai.

error object

Model kesalahan logis yang menjelaskan status kesalahan.

metadata object

Berisi pesan berurutan acak bersama dengan @type yang menggambarkan jenis pesan berurutan.

path string

Jalur sumber daya yang ditugaskan oleh server. Format default adalah operations/{operation_id} .

response object

Berisi pesan berurutan acak bersama dengan @type yang menggambarkan jenis pesan berurutan.

Izin yang Diperlukan

Izin kunci API berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara membuat kunci yang tepat, lihat Cara Mengelola Kunci API.

  • Baca

Batas

Per Kunci API: 100 permintaan setiap 60 detik per Alamat IP

Objek

Objek berikut mendeskripsikan muatan yang diterima atau diberikan. Lihat masing-masing endpoint untuk mengetahui informasi selengkapnya tentang waktu penggunaan objek ini.

Any

Berisi pesan berurutan acak bersama dengan @type yang menggambarkan jenis pesan berurutan.

Atribut

@type string

Jenis pesan serbaik terenkripsi.

Asset

Mewakili aset.

Atribut

assetId number

Pengenal unik dari aset. Diperlukan untuk Update Asset.

assetType string

ketikaset. Hanya bisa Audio , Decal , atau Model . Diperlukan untuk Buat Aset .

creationContext object

Konteks penciptaan yang bukan bagian dari konten aset, seperti metadata dan informasi pencipta. Diperlukan untuk Buat Asset .

description string

Deskripsi aset. Batasi hingga 1000 karakter. Diperlukan untuk Buat Aset .

displayName string

Nama tampilan dari aset. Diperlukan untuk Buat Aset.

icon string

Jalur sumber daya untuk ikon.

moderationResult object

Hasil moderasi dari aset.

path string

Jalur sumber daya yang dikembalikan dari aset. Format: assets/{assetId} . Contoh: assets/2205400862 .

previews array<object>

Daftar pratinjau, masing-masing dengan jalur aset dan teks alternatif. Pratinjau harus menjadi Gambar aset.

revisionCreateTime string

timestamp penciptaan revisi saat ini.

revisionId string

ID revisi dari aset.Setara dengan versionNumber .Setiap perubahan aset secara otomatis melakukan komitmen versi baru.Format adalah string bilangan bulat.Contoh: 1 .

socialLink object

Tautan media sosial untuk aset.Maksimum tiga per aset.Nama objek bisa menjadi salah satu dari:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
Untuk sintaks, lihat permintaan contoh di bawah Update Asset .

state string

Apakah aset aktif atau diarsipkan. Tidak ditentukan tidak digunakan.

AssetVersion

Versi aset.

Atribut

creationContext object

Konteks penciptaan yang bukan bagian dari konten aset, seperti metadata dan informasi pencipta. Diperlukan untuk Buat Asset .

moderationResult object

Hasil moderasi dari aset.

path string

Jalur sumber daya yang dikembalikan dari versi aset. Format: assets/{assetId}/versions/{version} . Contoh: assets/2205400862/versions/1 .

CreationContext

Konteks penciptaan yang bukan bagian dari konten aset, seperti metadata dan informasi pencipta. Diperlukan untuk Buat Asset .

Atribut

creator object

Mewakili seorang kreator.

Diperlukan
expectedPrice number

Biaya upload aset yang diharapkan di Robux. Saat harga aktual lebih dari yang diharapkan, operasi gagal dengan kesalahan 400.

Creator

Mewakili seorang kreator.

Atribut

groupId number

ID Grup. Diperlukan jika aset dimiliki kelompok.

userId number

ID Pengguna kreator. Diperlukan jika aset dimiliki oleh pengguna individu.

ModerationResult

Hasil moderasi dari aset.

Atribut

moderationState string

Status moderasi dari aset. Bisa menjadi Reviewing , Rejected , atau Approved .

Operation

Sumber daya ini mewakili operasi berjalan lama yang merupakan hasil dari panggilan API jaringan.

Atribut

done boolean

Jika false , operasi masih dalam progres. Jika true , operasi selesai.

error object

Model kesalahan logis yang menjelaskan status kesalahan.

metadata object

Berisi pesan berurutan acak bersama dengan @type yang menggambarkan jenis pesan berurutan.

path string

Jalur sumber daya yang ditugaskan oleh server. Format default adalah operations/{operation_id} .

response object

Berisi pesan berurutan acak bersama dengan @type yang menggambarkan jenis pesan berurutan.

Preview

Pratinjau aset.

Atribut

altText string

Teks alternatif untuk aset pratinjau.

asset string

Jalur pratinjau aset.

Tautan media sosial untuk aset.Maksimum tiga per aset.Nama objek bisa menjadi salah satu dari:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
Untuk sintaks, lihat permintaan contoh di bawah Update Asset .

Atribut

title string

Judul opsional untuk tautan media sosial. Tidak digunakan di Pusat Kreator.

uri string

URI untuk tautan media sosial.Harus cocok dengan format yang diharapkan untuk jenis tautkan.Sebagai contoh, judul untuk objek twitchSocialLink harus berformat https://twitch.tv/your-channel.

State

Apakah aset aktif atau diarsipkan. Tidak ditentukan tidak digunakan.

Atribut

string (enum): "Unspecified", "Active", "Archived"

Status

Model kesalahan logis yang menjelaskan status kesalahan.

Atribut

code number

kodestatus HTTP.

details array<object>

Daftar pesan yang membawa rincian kesalahan.

message string

Pesan pesan.