Skip to main content
Referensi Open API Acting

Referensi API HappyOyster-Acting-Create World

Buat World role-play. Buat World dari prompt bahasa alami dan gambar frame pertama yang wajib diisi; API segera mengembalikan ID World terenkripsi (encryptedWorldId), World dibangun secara asinkron di latar belakang, dan klien melakukan polling progres pembangunan hingga selesai.

Cakupan

Buat Acting 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 Acting World. Anda tidak perlu meneruskan mode (server menuliskan 3; meneruskan nilai selain 3 akan mengembalikan 400000). creationModel selalu bernilai simple, uploadMode ditetapkan ke first_frame, dan versi masuk ruangan ditetapkan ke actingV2.

Permintaan HTTP

  • Singapore
  • AS (Virginia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/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-acting/openapi/v1/worlds' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "async": true,
    "prompt": "A blonde girl with twin tails, a white bow, and a golden crescent crown on her forehead; a white shirt with a navy sailor collar and a blue bow tie, and a blue-and-white argyle short skirt. Her right hand holds up a yellow sticky note that reads \"Good night\". Behind her are a deep-red velvet curtain and a cluster of flowers. Facing the camera, an anime-realistic blend, warm indoor lighting.",
    "resolution": "480p",
    "aspectRatio": "9:16",
    "firstFrameImage": {
        "url": "https://g-adoc.alcasset.com/media/maas_docs/sfm-cn/common/images/6a4b3c2d1e0f9fc5.png",
        "referenceType": "default"
    }
}'
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.
creationModel string (Opsional)Sub-mode pembuatan. Defaultnya adalah simple; Acting hanya mendukung simple.
prompt string (Wajib)Deskripsi bahasa alami tentang karakter, adegan, dan tujuan pertunjukan. Tidak boleh kosong, maksimal 2000 karakter. Jika hilang, kosong, atau melebihi panjang akan mengembalikan 400000.
uploadMode string (Opsional)Mode unggah gambar. Defaultnya adalah first_frame; Acting hanya mendukung first_frame.
resolution string (Opsional)Resolusi video. Defaultnya adalah 480p. Nilai yang diizinkan:
  • 480p
  • 720p
aspectRatio string (Opsional)Rasio frame streaming, yang juga menentukan orientasi gambar frame pertama; menjaga keduanya tetap konsisten sangat direkomendasikan. Defaultnya adalah 9:16. Nilai yang diizinkan:
  • 9:16 (potret): disarankan menggunakan frame pertama potret
  • 16:9 (lanskap): disarankan menggunakan frame pertama lanskap
Artinya, untuk streaming potret (9:16) gunakan frame pertama potret, dan untuk streaming lanskap (16:9) gunakan frame pertama lanskap. Defaultnya adalah 9:16; jika lanskap diperlukan, Anda harus secara eksplisit meneruskan aspectRatio=16:9.
refWorldId string (Opsional)Menurunkan kreasi baru dari Acting World yang sudah ada. Harus berupa ID World terenkripsi Acting 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 sebagai frame 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: ketika aspectRatio=9:16, lebar / tinggi adalah 0.5–0.667; ketika aspectRatio=16:9, nilainya adalah 1.5–2.0
  • 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 referensi frame pertama. Defaultnya adalah default, dan saat ini digunakan sebagai default.

Parameter respons

  • Pembuatan asinkron
  • Permintaan gagal
{
    "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; pesan kesalahan yang dapat dibaca manusia jika gagal.
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: sedang dibuat
  • ready: siap
  • failed: pembuatan 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