Buat World role-play. Buat World dari prompt bahasa alami dan gambar frame pertama yang wajib diisi; API segera mengembalikan ID World terenkripsi (encryptedWorldId), World dibangun secara asinkron di latar belakang, dan klien melakukan polling progres pembangunan hingga selesai.
Cakupan
Buat Acting World. Sebelum memanggil, pastikan hal berikut:
-
Autentikasi: Hanya API Key utama yang didukung; API Key sementara tidak dapat digunakan (kode kesalahan
403003).- Dapatkan API Key utama: Mendapatkan dan mengonfigurasi API Key.
-
Mode pemanggilan: Mode asinkron direkomendasikan.
- Mode asinkron (default):
async=true, API segera mengembalikanencryptedWorldId; lakukan polling Query World Build Status untuk melihat progres. - Mode sinkron:
async=false, server melakukan polling secara internal (setiap 3 detik, hingga 120 detik) dan mengembalikan hasil saat pembangunan selesai; jika waktu habis, sistem kembali ke mode asinkron dan klien terus melakukan polling.
- Mode asinkron (default):
-
Batasan endpoint: Endpoint ini hanya dapat membuat Acting World. Anda tidak perlu meneruskan
mode(server menuliskan3; meneruskan nilai selain3akan mengembalikan400000).creationModelselalu bernilaisimple,uploadModeditetapkan kefirst_frame, dan versi masuk ruangan ditetapkan keactingV2.
Permintaan HTTP
- Singapore
- AS (Virginia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worldsGanti {WorkspaceId} dengan ID Workspace Anda yang sebenarnya.Parameter permintaan |
|
Content-Typestring(Wajib)Tipe konten permintaan. Parameter ini harus diatur ke application/json. | |
Authorization string (Wajib)Autentikasi API Key. Hanya API Key utama yang didukung; dimulai dengan sk-, misalnya sk-xxx. Biasanya dikonfigurasi sebagai variabel lingkungan $DASHSCOPE_API_KEY. API Key sementara (dimulai dengan st-) akan mengembalikan 403003. | |
Request Body | |
async boolean (Opsional)Apakah akan membuat secara asinkron. Defaultnya adalah true:
| |
creationModel string (Opsional)Sub-mode pembuatan. Defaultnya adalah simple; Acting hanya mendukung simple. | |
prompt string (Wajib)Deskripsi bahasa alami tentang karakter, adegan, dan tujuan pertunjukan. Tidak boleh kosong, maksimal 2000 karakter. Jika hilang, kosong, atau melebihi panjang akan mengembalikan 400000. | |
uploadMode string (Opsional)Mode unggah gambar. Defaultnya adalah first_frame; Acting hanya mendukung first_frame. | |
resolution string (Opsional)Resolusi video. Defaultnya adalah 480p. Nilai yang diizinkan:
| |
aspectRatio string (Opsional)Rasio frame streaming, yang juga menentukan orientasi gambar frame pertama; menjaga keduanya tetap konsisten sangat direkomendasikan. Defaultnya adalah 9:16. Nilai yang diizinkan:
9:16) gunakan frame pertama potret, dan untuk streaming lanskap (16:9) gunakan frame pertama lanskap. Defaultnya adalah 9:16; jika lanskap diperlukan, Anda harus secara eksplisit meneruskan aspectRatio=16:9. | |
refWorldId string (Opsional)Menurunkan kreasi baru dari Acting World yang sudah ada. Harus berupa ID World terenkripsi Acting di bawah akun utama saat ini; World dari model lain atau akun utama lain akan mengembalikan 403001. | |
firstFrameImage object (Wajib)Referensi gambar yang digunakan kembali sebagai frame pertama World. url dan base64 saling eksklusif (pilih salah satu). Batasan gambar:
Properti url string (Wajib bersyarat)URL gambar frame pertama. Saling eksklusif dengan base64 (pilih salah satu). Batasan:
string (Wajib bersyarat)Base64 gambar frame pertama. Saling eksklusif dengan url (pilih salah satu). Batasan:
string (Opsional)Tipe referensi frame pertama. Defaultnya adalah default, dan saat ini digunakan sebagai default. |
Parameter respons |
|
code integerKode pengembalian. 0 berarti berhasil; bukan nol adalah kode kesalahan. | |
message stringPesan kesalahan. null jika berhasil; pesan kesalahan yang dapat dibaca manusia jika gagal. | |
data objectData respons. null jika gagal.
Properti encryptedWorldId stringID World terenkripsi yang dihasilkan oleh server. Dikembalikan dalam mode sinkron maupun asinkron; digunakan untuk polling status pembangunan selanjutnya, kueri detail, dan penukaran kredensial perjalanan.status stringStatus pembuatan saat ini:
stringURL frame pertama World; null sebelum dihasilkan. |
Kode kesalahan
Jika pemanggilan model gagal dan mengembalikan kesalahan, lihat Kode Kesalahan HappyOyster untuk menyelesaikannya.
Langkah selanjutnya
Setelah berhasil membuat, Anda dapat:
- Query World Build Status: lakukan polling setiap 3–5 detik hingga World memasuki status
ready. - Setelah World memasuki status
ready, panggil Get Travel Credential untuk ditukarkan denganticketsekali pakai. - Query World Detail: kueri metadata pembuatan lengkap.