Skip to main content
Referensi Open API Adventure

Referensi API HappyOyster-Adventure-Query World Build Status

Melakukan kueri terhadap progres pembangunan Adventure World. API ini mengembalikan ID World terenkripsi, status pembangunan, dan URL frame pertama; klien melakukan polling hingga World memasuki status ready.

Cakupan

Melakukan kueri terhadap progres pembangunan Adventure World. Sebelum memanggil, pastikan hal berikut:
  • Autentikasi: primary API Key tidak wajib; primary API Key atau temporary API Key dapat memanggil endpoint ini. Untuk cara mendapatkannya, lihat Mendapatkan kredensial autentikasi.
  • Prasyarat: Lakukan kueri dengan encryptedWorldId yang dikembalikan oleh Create World. Anda dapat mulai melakukan kueri dari status generating.
  • Pemanggil: Server atau klien Anda dapat memanggilnya.

Permintaan HTTP

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

Parameter permintaan

  • Kueri status pembangunan World
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/build-status?encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
Authorization string (Wajib)Autentikasi Kunci API. Kunci API utama tidak wajib; kunci API utama atau sementara dapat digunakan untuk memanggilnya.
  • API Key Utama: dimulai dengan sk-, misalnya sk-xxx.
  • Kunci API Sementara: diawali dengan st-, misalnya st-xxx.
Parameter kueri
encryptedWorldId string (Wajib)ID World terenkripsi yang dikembalikan oleh Create World. ID ini dienkripsi oleh server; Anda tidak perlu mendekripsinya.

Parameter respons

  • Membangun
  • Pembangunan selesai
{
    "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.status stringStatus pembangunan:
  • generating: sedang dibuat
  • ready: siap; Anda dapat menukarkan kredensial travel dan memasuki ruangan
  • failed: pembuatan gagal
firstFrame stringURL frame pertama World; null jika belum dibuat atau jika pembangunan gagal.name stringNama World. Hanya dikembalikan ketika status=ready.mode integerSelalu 1 untuk Adventure. Dikembalikan hanya ketika status=ready.

Status prasyarat dan catatan pemanggilan

  • Lakukan polling setiap 3–5 detik hingga status bernilai ready atau failed.
  • Hanya World ready yang dapat menukarkan kredensial travel dan memasuki ruangan.
  • Ketika gambar URL gagal divalidasi setelah penyimpanan asinkron, World dapat berubah dari generating menjadi failed.
  • Endpoint ini tidak mengembalikan aspectRatio; ketika Anda memerlukan metadata pembuatan seperti perspective atau uploadMode, panggil Query World Detail.

Kode kesalahan

Jika pemanggilan model gagal dan mengembalikan kesalahan, lihat Kode Kesalahan HappyOyster untuk menyelesaikannya.

Langkah selanjutnya

Setelah World memasuki ready:
Penggunaan API
Generasi teks
Pembuatan Gambar
  • FAQ
Video Generation
Model Dunia
Audio
  • Pembuatan audio
Real-time multimodal
Realtime API
Penyematan Teks
Lainnya Model
Toolkit/Framework
TokenPlan
Model production
Manajemen file
Penagihan
Manajemen Model
Lebih Banyak Tentang Model