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 berikut pengiriman dan respons pemuatan 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 aset tertentu, dengan pembagian halaman yang opsional.

Parameter

assetId string

Pengenal unik dari aset.

Path
Diperlukan
maxPageSize number

Meng指定资产版本数量 yang harus di包含 dalam response. Nilai valid berada di antara 1 到 50 (包括). Standar untuk 8 當 tidak diberikan.

pageToken string

Token untuk pembagian halaman.Nilai diambil 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

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

Cakupan berikut diperlukan agar aplikasi OAuth 2.0 dapat menggunakan endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara mendaftarkan aplikasi OAuth 2.0, lihat Pendaftaran dan review aplikasi.

  • asset:read

Batas

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

Versi Aset Rollback

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

Putar kembali aset ke versi sebelumnya yang spesifik.

Parameter

assetId string

Pengenal unik dari aset.

Path
Diperlukan
assetVersion string

Jalan versi aset dalam format assets/{assetId}/versions/{versionNumber} .

FormData
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

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

Cakupan berikut diperlukan agar aplikasi OAuth 2.0 dapat menggunakan endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara mendaftarkan aplikasi OAuth 2.0, lihat Pendaftaran dan review aplikasi.

  • asset:read

  • asset:write

Batas

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

Dapatkan Aset

GET /v1/assets

Akses konten aset spesifik dan metadata.

Parameter

assetId

Pengenal unik dari aset.

Path
Diperlukan
readMask string

Ladang metadata aset untuk mengambil, termasuk deskripsi, nama display, ikon, sosial link, 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

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

Cakupan berikut diperlukan agar aplikasi OAuth 2.0 dapat menggunakan endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara mendaftarkan aplikasi OAuth 2.0, lihat Pendaftaran dan review aplikasi.

  • asset:read

Batas

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

Buat Aset

POST /v1/assets

Menciptakan aset dengan konten dan metadaten yang disediakan.

Anda tidak dapat menambahkan SocialLink objek saat Anda membuat aset. Sebaliknya, gunakan Update Asset .

Parameter

request

Attribut aset untuk membuat atau menyetel update. Kirim sebagai data bentuk seperti contoh permintaan berikut menunjukkan.

FormData
Diperlukan
fileContent string

Jalan file aset biner dan ketikkonten.Format: fileContent=@"/filepath/{File}";type={ContentType} . Contoh: fileContent=@"/filepath/model.fbx";type=model/fbx . Lihat Jenis Konten .

FormData
Diperlukan

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
Mengembalikan ID Operasi untuk memeriksa status pembuatan.
Memberikan nilai object
done boolean

Jika false, operasi masih sedang berlangsung. Jika true, operasi selesai.

error object

Model kesalahan logik yang menjelaskan status kesalahan.

metadata object

Berisi pesan serialisasi acak bersama dengan sebuah @type yang menggambarkan jenis pesan serialisasi.

path string

Jalan sumber daya yang ditunjuk server.Format default adalah operations/{operation_id} .

response object

Berisi pesan serialisasi acak bersama dengan sebuah @type yang menggambarkan jenis pesan serialisasi.

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

Cakupan berikut diperlukan agar aplikasi OAuth 2.0 dapat menggunakan endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara mendaftarkan aplikasi OAuth 2.0, lihat Pendaftaran dan review aplikasi.

  • asset:read

  • asset:write

Batas

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

Perbarui Aset

PATCH /v1/assets/{assetId}

Meng更新资产 with provided content and metadata, including the deskripsi, nama display, ikon, social links, dan previews. 目前只能更新内容体 for Model . Icons dan Previews must be Image 资产。 Icons must have square dimensions.

Parameter

request

Kirim sebagai data bentuk seperti contoh permintaan berikut.

FormData
Diperlukan
fileContent string

Jalan file aset biner dan ketikkonten.Format: fileContent=@"/filepath/{File}";type={ContentType} . Contoh: fileContent=@"/filepath/model.fbx";type=model/fbx . Lihat Jenis Konten .

FormData
updateMask string

Ladang 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
Mengembalikan ID Operasi untuk memeriksa status pembaruan / Mengembalikan field metadaten yang diperbarui.
Memberikan nilai object
application/json
{\"previews\": [\n    {\"asset\": \"assets/123\", \"altText\": \"preview 1\"},\n    {\"asset\": \"assets/456\", \"altText\": \"preview 2\"}\n]}
done boolean

Jika false, operasi masih sedang berlangsung. Jika true, operasi selesai.

error object

Model kesalahan logik yang menjelaskan status kesalahan.

metadata object

Berisi pesan serialisasi acak bersama dengan sebuah @type yang menggambarkan jenis pesan serialisasi.

path string

Jalan sumber daya yang ditunjuk server.Format default adalah operations/{operation_id} .

response object

Berisi pesan serialisasi acak bersama dengan sebuah @type yang menggambarkan jenis pesan serialisasi.

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

Cakupan berikut diperlukan agar aplikasi OAuth 2.0 dapat menggunakan endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara mendaftarkan aplikasi OAuth 2.0, lihat Pendaftaran dan review aplikasi.

  • asset:read

  • asset:write

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 oleh ID aset dan nomor versi.

Parameter

assetId string

Pengenal unik dari aset.

Path
Diperlukan
versionNumber string

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

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

Cakupan berikut diperlukan agar aplikasi OAuth 2.0 dapat menggunakan endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara mendaftarkan aplikasi OAuth 2.0, lihat Pendaftaran dan review aplikasi.

  • asset:read

Batas

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

Dapatkan Operasi

GET /v1/operations/{operationId}

Dapatkan hasil dari pembuatan atau pembaruan aset menggunakan ID Operasi yang dikembalikan. Memerlukan Baca untuk izin API dan membaca untuk aplikasi OAuth 2.0.

Permintaan

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

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

Respons

200 - OK
Memberikan nilai object
done boolean

Jika false, operasi masih sedang berlangsung. Jika true, operasi selesai.

error object

Model kesalahan logik yang menjelaskan status kesalahan.

metadata object

Berisi pesan serialisasi acak bersama dengan sebuah @type yang menggambarkan jenis pesan serialisasi.

path string

Jalan sumber daya yang ditunjuk server.Format default adalah operations/{operation_id} .

response object

Berisi pesan serialisasi acak bersama dengan sebuah @type yang menggambarkan jenis pesan serialisasi.

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

Cakupan berikut diperlukan agar aplikasi OAuth 2.0 dapat menggunakan endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara mendaftarkan aplikasi OAuth 2.0, lihat Pendaftaran dan review aplikasi.

  • asset:read

Batas

Per Kunci API: 60 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 serialisasi acak bersama dengan sebuah @type yang menggambarkan jenis pesan serialisasi.

Atribut

@type string

Jenis pesan serius.

Asset

Menggambarkan aset.

Atribut

assetId number

Pengenal unik dari aset. Diperlukan untuk Update Asset .

assetType string

ketikaset. Hanya bisa Audio, Decal, atau Model. Diperlukan untuk 1> Buat Aset1> .

creationContext object

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

description string

Deskripsi dari aset. Batas 1000 karakter. Diperlukan untuk Buat Aset .

displayName string

Nama tampilan dari aset. Diperlukan untuk Buat Aset .

icon string

Jalan sumber daya untuk ikon.

moderationResult object

Hasil moderasi dari aset.

path string

Jalan tersalurkan dari sumber daya.Format: assets/{assetId} . Contoh: assets/2205400862 .

previews array<object>

Daftar pratinjau, masing-masing dengan jalan akses aset dan teks alternatif. Pratinjau harus menjadi Image aset.

revisionCreateTime string

Waktu pembuatan revisi saat ini.

revisionId string

ID revisi aset. Setara dengan versionNumber . Setiap perubahan aset secara otomatis mengkomitmen versi baru.Format adalah string int. Contoh: 1 .

socialLink object

Sebuah taut

CreationContext

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

Atribut

creator object

M mewakili kreator.

Diperlukan
expectedPrice number

Diharapkan biaya pengunggahan aset dalam Robux. Ketika harga yang sebenarnya lebih dari yang diharapkan, operasi gagal dengan kesalahan 400.

Creator

M mewakili kreator.

Atribut

groupId number

ID Grup. Diperlukan jika aset dimiliki kelompok.

userId number

ID Pengguna yang dibuat oleh kreator. Diperlukan jika aset adalah milik pengguna individual.

ModerationResult

Hasil moderasi dari aset.

Atribut

moderationState string

Negara moderasi aset. Dapat menjadi MODERATION_STATE_REVIEWING, MODERATION_STATE_REJECTED, atau MODERATION_STATE_APPROVED.

Operation

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

Atribut

done boolean

Jika false, operasi masih sedang berlangsung. Jika true, operasi selesai.

error object

Model kesalahan logik yang menjelaskan status kesalahan.

metadata object

Berisi pesan serialisasi acak bersama dengan sebuah @type yang menggambarkan jenis pesan serialisasi.

path string

Jalan sumber daya yang ditunjuk server.Format default adalah operations/{operation_id} .

response object

Berisi pesan serialisasi acak bersama dengan sebuah @type yang menggambarkan jenis pesan serialisasi.

Preview

Pratinjau aset.

Atribut

altText string

Teks alternatif untuk aset pratinjau.

asset string

Jalan pintas aset pratinjau.

Sebuah taut

Atribut

title string

Judul opsi untuk tautkanmedia sosial. Tidak digunakan di Pusat Kreator.

uri string

URL untuk tautkanmedia sosial. Harus cocok dengan format yang diharapkan untuk jenis tautkan. Misalnya, judul untuk objek twitchSocialLink harus dari format https://twitch.tv/your-channel.

Status

Model kesalahan logik yang menjelaskan status kesalahan.

Atribut

code number

kodestatus HTTP.

details array<object>

Daftar pesan yang mengandung rincian kesalahan.

message string

Pesan pesan.