Skip to main content
Referensi Open API Acting

Referensi API HappyOyster-Acting-Query World Detail

Kueri metadata lengkap dan parameter pembuatan yang dapat digemakan dari satu Acting World. Untuk polling progres pembangunan, gunakan endpoint Query World Build Status.

Cakupan

Kueri metadata lengkap dan parameter pembuatan yang dapat digemakan dari satu Acting World. Sebelum memanggil, pastikan hal berikut:
  • Autentikasi: Hanya API Key utama yang didukung; API Key sementara tidak dapat digunakan (kode kesalahan 403003).
  • Prasyarat: Lakukan kueri dengan encryptedWorldId yang dikembalikan oleh Create World. Untuk polling progres pembangunan, gunakan Query World Build Status.
  • Pemanggil: Dipanggil oleh server Anda.

Permintaan HTTP

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

Parameter permintaan

  • Kueri detail World
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/detail?encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
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.
Parameter kueri
encryptedWorldId string (Wajib)ID World terenkripsi Acting di bawah akun utama saat ini. Dikembalikan oleh Create World.

Parameter respons

Query succeeded
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "name": "Late-Night Video Call",
        "status": "ready",
        "mode": 3,
        "creationModel": "simple",
        "prompt": "During a late-night video call, a quiet girl smiles back at the camera",
        "eventStyle": "first_frame",
        "perspective": null,
        "uploadMode": "first_frame",
        "resolution": "480p",
        "aspectRatio": "9:16",
        "layout": null,
        "narrative": null,
        "refWorldId": null,
        "firstFrameImage": {
            "url": "https://cdn.happyoyster.com/frames/portrait-call.jpg",
            "referenceType": "default"
        },
        "inputImages": null,
        "sceneImage": null,
        "roleImage": null,
        "scenePrompt": null,
        "rolePrompt": null,
        "scriptList": null,
        "previewUrl": null,
        "createdAt": "2026-09-09T08:00:00Z",
        "updatedAt": "2026-09-09T08:05:00Z"
    }
}
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.name stringNama World.status stringStatus pembangunan: generating / ready / failed.mode integerSelalu 3 untuk Acting.creationModel stringSelalu simple untuk Acting.prompt stringPrompt tingkat atas yang dikirimkan saat pembuatan.eventStyle stringField pengembalian kompatibilitas; ketika pembuatan yang sesuai menghilangkan field ini, server biasanya memetakannya dari uploadMode dan menggemakan first_frame. Ini bukan parameter pembuatan Acting, dan klien tidak boleh mengirimkannya kembali.perspective nullActing tidak menerima parameter pembuatan perspective; ditetapkan ke null.uploadMode stringDitetapkan ke first_frame.resolution string480p / 720p; 480p jika tidak diteruskan saat pembuatan.aspectRatio string9:16 / 16:9; 9:16 jika tidak diteruskan saat pembuatan.layout nullActing tidak menerima parameter pembuatan ini; ditetapkan ke null.narrative nullActing tidak menerima parameter pembuatan ini; ditetapkan ke null.refWorldId stringID World referensi terenkripsi Acting yang digunakan untuk pembuatan turunan; null jika none.firstFrameImage objectGambar frame pertama yang wajib saat pembuatan; hanya dikembalikan dalam bentuk URL, base64 tidak dikembalikan. Berisi url dan referenceType.inputImages nullActing saat ini tidak menggunakan field ini.sceneImage nullActing tidak menggunakan slot gambar scene/role; ditetapkan ke null.roleImage nullActing tidak menggunakan slot gambar scene/role; ditetapkan ke null.scenePrompt nullActing tidak menggunakan prompt scene/role; ditetapkan ke null.rolePrompt nullActing tidak menggunakan prompt scene/role; ditetapkan ke null.scriptList nullActing tidak mendukung ScriptList; ditetapkan ke null.previewUrl nullSaat ini ditetapkan ke null.createdAt stringWaktu pembuatan, dalam format ISO 8601.updatedAt stringWaktu pembaruan terakhir, dalam format ISO 8601.

Status prasyarat dan catatan pemanggilan

  • Endpoint ini dapat mengkueri World generating, ready, atau failed; beberapa artefak pembangunan mungkin bernilai null sebelum siap.
  • Endpoint detail tidak menggemakan async, karena ini adalah pengalih perilaku panggilan, bukan atribut World.
  • Gambar hanya dikembalikan sebagai URL dan referenceType; konten base64 dalam permintaan pembuatan tidak dikembalikan.
  • eventStyle biasanya memiliki nilai yang sama dengan uploadMode; klien harus menganggap uploadMode sebagai field otoritatif untuk mode pembuatan Acting.
  • Pemutar dapat membaca sebelumnya aspectRatio, namun saat benar-benar memasuki ruangan, orientasi tetap harus diatur dari nilai respons Enter Travel.
  • Melakukan kueri terhadap World dari model lain, akun utama lain, atau World yang telah dihapus akan selalu mengembalikan 403001, tanpa mengungkapkan apakah sumber daya tersebut ada atau tidak.

Kode kesalahan

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

Langkah selanjutnya

Pembuatan Gambar
  • FAQ
Video Generation
Audio
  • Pembuatan audio
Realtime API
Penyematan Teks
TokenPlan
Model production