Skip to main content
Referensi Open API Adventure

Referensi API HappyOyster-Adventure-Create World

Buat World eksplorasi dunia. Buat World dari prompt bahasa alami dan gambar bingkai pertama yang wajib diisi; API segera mengembalikan ID World terenkripsi, World dibangun secara asinkron di latar belakang, dan klien melakukan polling terhadap progres pembangunan hingga selesai.

Cakupan

Buat Adventure World. Sebelum memanggil, pastikan hal berikut:
  • Autentikasi: Hanya API Key utama yang didukung; API Key sementara tidak dapat digunakan (kode kesalahan 403003).
  • Mode pemanggilan: Mode asinkron direkomendasikan.
    • Mode asinkron (default): async=true, API segera mengembalikan encryptedWorldId; 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.
  • Batasan endpoint: Endpoint ini hanya dapat membuat Adventure World. Anda tidak perlu meneruskan mode (server menulis 1; meneruskan nilai selain 1 akan mengembalikan 400000). creationModel selalu simple, uploadMode ditetapkan ke first_frame, dan versi enter-room ditetapkan ke wanderV2.

Permintaan HTTP

  • Singapore
  • Tiongkok (Beijing)
  • AS (Virginia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worldsGanti {WorkspaceId} dengan ID Workspace Anda yang sebenarnya.

Parameter permintaan

  • Gambar frame pertama (asinkron)
  • Base64 gambar frame pertama (asinkron)
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "async": true,
    "perspective": "third_person",
    "prompt": "Third-person tracking shot: a rider in a black snowsuit and black helmet drives a black snowmobile into the distance, the track kicking up fine snow. Ahead lies a snow-covered coniferous forest; farther off, steep sunlit rock cliffs of snow mountains under a blue sky with white clouds. Clear winter sky, strong snow highlights, open and crisp.",
    "firstFrameImage": {
        "url": "https://g-adoc.alcasset.com/media/maas_docs/sfm-cn/common/images/6a4b3c2d1e0f9fc6.png"
    }
}'
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:
  • true: mengembalikan hasil segera; World dibangun di latar belakang, dan klien melakukan polling Query World Build Status.
  • false: server melakukan polling setiap 3 detik hingga maksimal 120 detik dan mengembalikan hasil saat pembangunan selesai; jika waktu habis, sistem tetap mengembalikan generating, dan klien kemudian melakukan polling secara mandiri.
perspective string (Wajib)Perspektif. Nilai yang diizinkan:
  • first_person: orang pertama
  • third_person: orang ketiga
Mengabaikan bidang ini mengembalikan 400000.
prompt string (Wajib)Deskripsi tema World; bahasa Mandarin dan Inggris didukung. Tidak boleh kosong, hingga 2000 karakter. Jika hilang, kosong, atau melebihi panjang, akan mengembalikan 400000.
creationModel string (Opsional)Sub-mode pembuatan. Defaultnya adalah simple; Adventure hanya mendukung simple.
uploadMode string (Opsional)Mode unggah gambar. Defaultnya adalah first_frame; Adventure hanya mendukung first_frame.
refWorldId string (Opsional)Turunkan kreasi baru dari Adventure World yang sudah ada. Harus berupa ID World terenkripsi Adventure 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 secara langsung sebagai bingkai pertama World. url dan base64 saling eksklusif (pilih salah satu). Batasan gambar:
  • Format: JPG / JPEG / PNG / WebP
  • Ukuran: harus kurang dari 6 MB per gambar
  • Rasio aspek: harus lanskap, lebar / tinggi sebesar 1.5–2.0 (rasio bingkai mengikuti gambar ini)
  • Keamanan konten: kegagalan verifikasi keamanan konten atau hak cipta / IP mengembalikan 403004 / 403005

Properti

url string (Wajib bersyarat)URL gambar frame pertama. Saling eksklusif dengan base64 (pilih salah satu). Batasan:
  • Harus berupa URL http / https yang valid dengan host, dan dapat diakses oleh server
  • Format, ukuran, dan rasio aspek frame pertama yang sebenarnya divalidasi setelah penyimpanan
  • Permintaan asinkron mungkin pertama kali mengembalikan generating, kemudian World memasuki status failed karena kegagalan validasi gambar
base64 string (Wajib bersyarat)Base64 gambar frame pertama. Saling eksklusif dengan url (pilih salah satu). Batasan:
  • Data URI lengkap data:image/<subtype>;base64,<payload> direkomendasikan
  • Format, ukuran, dan rasio aspek frame pertama divalidasi secara sinkron pada titik masuk pembuatan
referenceType string (Opsional)Tipe gambar referensi. Defaultnya adalah default, dan saat ini digunakan sebagai default.

Parameter respons

  • Pembuatan asinkron
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "generating",
        "firstFrame": null
    }
}
code integerKode pengembalian. 0 berarti berhasil; bukan nol adalah kode kesalahan.
message stringPesan kesalahan. null jika berhasil.
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: generating (membangun) atau ready; bisa juga failed ketika pembangunan sinkron gagal.firstFrame 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:
Pembuatan Gambar
  • FAQ
Video Generation
Audio
  • Pembuatan audio
Realtime API
Penyematan Teks
TokenPlan
Model production