Skip to main content
Referensi Open API Adventure

Referensi API HappyOyster-Adventure-Query Travel Status

Melakukan kueri terhadap siklus hidup Adventure Travel, status streaming sisi server, dan kumpulan tindakan world saat ini; Anda juga dapat melaporkan heartbeat pull-stream atau pemutaran klien secara bersamaan.

Cakupan

Melakukan kueri terhadap siklus hidup Adventure Travel, status streaming sisi server, dan kumpulan tindakan world saat ini; Anda juga dapat melaporkan heartbeat pull-stream atau pemutaran klien secara bersamaan. Sebelum memanggil, pastikan hal berikut:
  • Autentikasi: Kunci API utama tidak wajib; kunci API utama atau sementara dapat digunakan untuk memanggilnya. Untuk cara mendapatkannya, lihat Mendapatkan kredensial autentikasi.
  • Prasyarat: Kueri menggunakan encryptedTravelId yang dikembalikan oleh Enter Travel.
  • Pemanggil: Server atau klien Anda dapat memanggilnya. Disarankan melakukan polling setiap 2–5 detik.

Permintaan HTTP

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

Parameter permintaan

  • Kueri status Travel
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/status?encryptedTravelId={encryptedTravelId}&clientStreamStatus=PLAYING&clientStreamStatusTimeMs=1788940800000' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
Authorization string (Wajib)Autentikasi Kunci API. Kunci API utama tidak wajib; kunci API utama atau sementara dapat digunakan untuk memanggilnya.
  • API Key Utama: dimulai dengan sk-, misalnya sk-xxx.
  • Kunci API Sementara: diawali dengan st-, misalnya st-xxx.
Parameter kueri
encryptedTravelId string (Wajib)ID Travel terenkripsi Adventure. Dikembalikan oleh Enter Travel.
clientStreamStatus string (Opsional)Status pull-stream RTC atau pemutaran klien, tidak peka huruf besar/kecil. Nilai yang tidak dikenali akan diabaikan. Nilai yang diizinkan:
  • DISCONNECTED: tidak terhubung atau telah meninggalkan channel
  • CONNECTING: menghubungkan ke channel RTC
  • CONNECTED: telah bergabung, namun pemutaran belum dimulai atau frame pertama belum tiba
  • PLAYING: stream jarak jauh telah diterima dan sedang dirender
  • BUFFERING: buffering
  • PAUSED: klien menjeda pemutaran; ini tidak berarti Adventure Travel mendukung jeda sisi server
  • RECONNECTING: menghubungkan ulang
clientStreamStatusTimeMs long (Opsional)Timestamp perubahan status klien dalam milidetik. Digunakan bersama dengan clientStreamStatus.

Parameter respons

  • Travel berjalan
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "running",
        "rtcStatus": "PUSHING",
        "updateTime": "2026-06-04T00:02:00Z",
        "userInstructions": null,
        "chapters": null,
        "characterActions": [
            "dash",
            "jump",
            "crouch",
            "attack"
        ],
        "environmentActions": [
            "ride_motorcycle",
            "enter_exit_car"
        ]
    }
}
code integerKode pengembalian. 0 berarti berhasil; bukan nol adalah kode kesalahan.
message stringPesan kesalahan. null jika berhasil.
data objectData respons. null jika gagal.

Properti

encryptedTravelId stringID Travel Terenkripsi.status stringStatus siklus hidup Travel:
  • init: menginisialisasi sumber daya sesi
  • pending: dalam antrean atau menunggu sumber daya layanan
  • running: berjalan; Anda dapat mengontrolnya secara real-time melalui SDK sendCommand
  • failed: Travel gagal
  • completed: Travel telah berakhir; artifacts dapat dikueri
Kemampuan produk Adventure tidak memiliki status paused; jangan membangun mesin status di sekitar fungsi jeda / lanjutkan.rtcStatus stringStatus streaming RTC sisi server; berbeda dari clientStreamStatus yang dilaporkan oleh klien.updateTime stringWaktu pembaruan terakhir, dalam format ISO 8601.userInstructions null | arrayAdventure tidak mendukung HTTP instruct, dan tindakan eksplorasi tidak digemakan ke bidang ini; biasanya null atau [], dan dapat diabaikan.chapters arrayDaftar bab; null jika belum ada data bab yang dihasilkan.characterActions arrayID tindakan yang tersedia untuk karakter / subjek saat ini; [] jika tidak ada rekomendasi. Biasanya 2–4 dikembalikan. Tindakan umum:
  • dash: berlari cepat ke depan
  • jump: melompat
  • crouch: membungkuk / tiarap
  • attack: menyerang
environmentActions arrayID tindakan interaksi lingkungan yang tersedia untuk adegan saat ini; [] jika tidak ada rekomendasi. Server memilih 0–3 dari kumpulan tindakan tetap berdasarkan adegan dan mungkin mengembalikan array kosong. Tindakan umum:
  • ride_horse: menunggang kuda
  • ride_bicycle: mengendarai sepeda
  • ride_motorcycle: mengendarai sepeda motor
  • enter_exit_car: masuk / keluar dari mobil
  • open_close_door: membuka / menutup pintu
  • take_cover: berlindung
  • car_light: menyalakan lampu mobil; mungkin muncul hanya jika enter_exit_car juga dikembalikan
  • car_horn: membunyikan klakson; mungkin muncul hanya jika enter_exit_car juga dikembalikan

Status prasyarat dan catatan pemanggilan

  • Lakukan polling setiap 2–5 detik.
  • Kemampuan produk Adventure tidak memiliki status paused; jangan membangun mesin status di sekitar fungsi jeda / lanjutkan.
  • characterActions dan environmentActions adalah petunjuk tindakan yang tersedia; kontrol aktual tetap dikirim melalui SDK sendCommand.
  • Endpoint ini tidak mengembalikan mode, playUrl, bgmUrl, atau sessionId; konfigurasi streaming didasarkan pada respons Enter Travel.
  • clientStreamStatus adalah heartbeat pemutaran sisi klien, dan rtcStatus adalah status streaming sisi server; keduanya tidak dapat saling menggantikan.
  • Adventure tidak mendukung HTTP instruct, pause, resume, rewind, atau update-script; jangan mengintegrasikan jalur berikut sebagai kemampuan HTTP yang tersedia: /travels/instruct, /travels/pause, /travels/resume, /travels/rewind, /travels/update-script.

Kode kesalahan

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

Langkah selanjutnya

Setelah Travel menjadi running:
  • Klien mengirimkan kontrol arah, sudut pandang, dan tindakan melalui SDK sendCommand (Anda dapat membaca kumpulan tindakan yang dikembalikan oleh endpoint ini terlebih dahulu).
  • Akhiri Travel: akhiri sesi dan tangani artefaknya.
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