Skip to main content
Referensi Open API Directing

Referensi API HappyOyster-Directing-Query World Detail

Kueri status saat ini, parameter pembuatan, dan informasi ScriptList yang dapat dikembalikan dari satu Directing World. Untuk polling progres pembangunan, gunakan endpoint Query World Build Status.

Cakupan

Kueri status saat ini, parameter pembuatan, dan informasi ScriptList yang dapat dikembalikan dari satu Directing 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-directing/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-directing/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 Directing di bawah akun utama saat ini. Dikembalikan oleh Create World.

Parameter respons

  • Kueri berhasil (mode skrip)
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "name": "Midnight Visitor",
        "status": "ready",
        "mode": 2,
        "creationModel": "scriptlist",
        "prompt": null,
        "eventStyle": "normal",
        "perspective": null,
        "uploadMode": null,
        "resolution": "720p",
        "layout": null,
        "narrative": null,
        "refWorldId": null,
        "firstFrameImage": {
            "url": "https://cdn.happyoyster.com/frames/room.png",
            "referenceType": "default"
        },
        "inputImages": null,
        "scriptList": {
            "synopsis": "Late at night, Su Li is startled awake by a knock at the door.",
            "videoTitle": "Midnight Visitor",
            "subjects": [
                {
                    "label": "[character_1]",
                    "name": "Su Li",
                    "type": "character",
                    "refImage": {
                        "url": "https://cdn.happyoyster.com/subjects/suli.png",
                        "referenceType": "default"
                    }
                }
            ],
            "acts": [
                {
                    "turn": 1,
                    "content": "Rain beats against the window, and [character_1] is startled awake from sleep.",
                    "cameraType": "Static",
                    "shotSize": "Wide",
                    "cut": "long-take"
                },
                {
                    "turn": 2,
                    "content": "[character_1] walks toward the door, and the knocking sounds again outside.",
                    "cameraType": "Push-in",
                    "shotSize": "Close-up",
                    "cut": "long-take"
                }
            ]
        },
        "previewUrl": null,
        "aspectRatio": null,
        "createdAt": "2026-06-03T10:00:00Z",
        "updatedAt": "2026-06-03T10: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 2 untuk Directing.creationModel stringsimple / scriptlist; menentukan endpoint kontrol mana yang dapat dipanggil oleh Travel.prompt stringPrompt yang digunakan saat membuat dalam mode simple; ditetapkan ke null untuk scriptlist.eventStyle stringGaya peristiwa saat pembuatan: normal / dramatic / regular.perspective nullBiasanya null untuk model Directing.uploadMode nullBiasanya null untuk Directing World.resolution string480p / 720p.layout stringGaya pergerakan kamera untuk mode simple; biasanya null jika tidak diteruskan atau untuk scriptlist.narrative stringGaya narasi untuk mode simple; biasanya null jika tidak diteruskan atau untuk scriptlist.refWorldId stringID World referensi terenkripsi yang digunakan untuk pembuatan turunan.firstFrameImage objectGambar frame pertama saat pembuatan; base64 tidak dikembalikan dalam respons.inputImages arrayGambar referensi yang disimpan saat membuat dalam mode simple; scriptlist tidak menerima bidang ini, sehingga biasanya bernilai null.scriptList objectMemiliki nilai hanya untuk World scriptlist; null ketika penguraian skrip terstruktur gagal. Berisi synopsis, videoTitle, scene, style, speed, language, setting, soundtrack, prologue, videoTags, subjects (dengan label/name/type/refImage, dll.), dan acts (dikembalikan secara lengkap sesuai dengan konten yang tersimpan, dengan turn/content/cameraType/shotSize/cut).previewUrl nullSaat ini ditetapkan ke null.aspectRatio nullDitetapkan ke null untuk model Directing.createdAt stringWaktu pembuatan, dalam format ISO 8601.updatedAt stringWaktu pembaruan terakhir, dalam format ISO 8601.

Status prasyarat dan catatan pemanggilan

  • Endpoint ini dapat melakukan kueri pada World generating, ready, atau failed.
  • Ini tidak menggemakan bidang async dari permintaan pembuatan.
  • Bidang gambar hanya mengembalikan URL dan referenceType, dan tidak pernah mengembalikan base64. inputImages untuk mode simple disimpan sebagai gambar referensi dan dapat dikembalikan dalam detail; scriptlist tidak menerima bidang ini.
  • Ketika scriptList berhasil diuraikan, struktur tersimpan lengkap dikembalikan, dan acts dikembalikan secara lengkap sesuai dengan konten yang tersimpan; ketika penguraian gagal, scriptList=null dikembalikan, dan acts kosong tidak digunakan untuk menunjukkan kegagalan penguraian.
  • 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