Referensi API HappyOyster-Directing-Query World Build Status

​

Cakupan

• 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

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/build-status?encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "generating",
        "firstFrame": null
    }
}

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "ready",
        "firstFrame": "https://cdn.happyoyster.com/frames/world_xyz789.jpg",
        "name": "Midnight Visitor",
        "mode": 2
    }
}

​

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.

​

Kode kesalahan

​

Langkah selanjutnya

• Get Travel Credential: tukarkan dengan ticket sekali pakai.
• Query World Detail: kueri metadata pembuatan lengkap.