Skip to main content
Referensi Open API Acting

Referensi API HappyOyster-Acting-Query World List

Telusuri Acting World di bawah akun utama saat ini secara bertahap. Endpoint ini secara otomatis diisolasi berdasarkan model dan tidak pernah mengembalikan World Directing atau Adventure.

Cakupan

Telusuri Acting World di bawah akun utama saat ini secara bertahap. Sebelum memanggil, pastikan hal berikut:
  • Autentikasi: Hanya API Key utama yang didukung; API Key sementara tidak dapat digunakan (kode kesalahan 403003).
  • 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/worldsGanti {WorkspaceId} dengan ID Workspace Anda yang sebenarnya.

Parameter permintaan

  • Kueri daftar World
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds?page=1&pageSize=20&status=ready' \
    -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
page integer (Opsional)Nomor halaman, defaultnya 1. Jika page <= 0, nilainya dianggap sebagai 1.
pageSize integer (Opsional)Jumlah item per halaman, defaultnya 20. Jika pageSize <= 0, nilainya dianggap sebagai 20; jika lebih besar dari 100, nilainya dibatasi hingga 100.
status string (Opsional)Filter berdasarkan status pembangunan. Nilai yang tidak dikenal tidak diterapkan sebagai filter. Nilai yang diizinkan:
  • generating: sedang dibuat
  • ready: siap
  • failed: pembuatan gagal
mode integer (Opsional)Tidak perlu meneruskan ini. Daftar sudah difilter ke model Acting, dan items[].mode selalu bernilai 3. Jika Anda tetap meneruskannya dan nilainya bukan 3, maka 400000 akan dikembalikan.

Parameter respons

Query succeeded
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedWorldId": "enc_a1b2****",
                "name": "Late-Night Video Call",
                "status": "ready",
                "mode": 3,
                "previewUrl": null,
                "createdAt": "2026-09-09T08:00:00Z",
                "perspective": null,
                "creationModel": "simple",
                "uploadMode": "first_frame"
            },
            {
                "encryptedWorldId": "enc_g7h8****",
                "name": "Relaxed Living Room Chat",
                "status": "ready",
                "mode": 3,
                "previewUrl": null,
                "createdAt": "2026-09-09T09:00:00Z",
                "perspective": null,
                "creationModel": "simple",
                "uploadMode": "first_frame"
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 2,
            "hasMore": false
        }
    }
}
code integerKode pengembalian. 0 berarti berhasil; bukan nol adalah kode kesalahan.
message stringPesan kesalahan. null jika berhasil.
data objectData respons. null jika gagal.

Properti

items arrayWorld pada halaman saat ini; array kosong jika tidak ada hasil. Setiap item berisi encryptedWorldId, name, status (generating / ready / failed), mode (selalu 3), previewUrl (biasanya null), createdAt, perspective (biasanya null), creationModel (selalu simple), dan uploadMode (ditetapkan ke first_frame).pagination objectInfo paginasi. Berisi page (nomor halaman saat ini), pageSize (jumlah item aktual per halaman), total (total jumlah catatan), dan hasMore (true ketika page × pageSize < total).

Status prasyarat dan catatan pemanggilan

  • Pemfilteran model berlaku secara otomatis; daftar tidak pernah mencampur World dari model lain, dan items[].mode selalu bernilai 3.
  • Item daftar adalah snapshot ringan; item tidak mengembalikan gambar, prompt, resolution, aspectRatio, atau refWorldId. Ketika Anda memerlukan konfigurasi lengkap, panggil Query World Detail.
  • Saat melakukan paging, gunakan pagination.pageSize dan hasMore dari respons; jangan berasumsi bahwa nilai yang diminta diadopsi secara harfiah.
  • Hasil kosong bukanlah kesalahan; respons akan mengembalikan items=[] beserta informasi paginasi yang sesuai.

Kode kesalahan

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

Langkah selanjutnya

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