Skip to main content
Referensi Open API Directing

Referensi API HappyOyster-Directing-Query Travel Status

Kueri siklus hidup Directing Travel, status streaming sisi server, instruksi teks yang dieksekusi, dan informasi bab; Anda juga dapat melaporkan heartbeat pull-stream atau pemutaran klien secara bersamaan.

Cakupan

Kueri siklus hidup Directing Travel, status streaming sisi server, instruksi teks yang dieksekusi, dan informasi bab; 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
  • AS (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/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-directing/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 Directing. 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 sama dengan pause 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": [
            {
                "instruction": "A giant robotic dinosaur suddenly appears",
                "relativeStartTimeMs": 12000,
                "relativeEndTimeMs": 16000,
                "startTime": 12.0,
                "endTime": 16.0,
                "status": "executed"
            }
        ],
        "chapters": [
            {
                "chapterId": 1,
                "title": "Chapter 1",
                "brief": "The detective enters the cyberpunk city",
                "actRange": [0, 10],
                "startTime": 4,
                "endTime": 20,
                "chapterImage": "https://cdn.happyoyster.com/chapters/ch1.jpg"
            }
        ],
        "characterActions": [],
        "environmentActions": []
    }
}
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 memanggil endpoint kontrol yang didukung sesuai dengan submode pembuatan
  • paused: jeda sisi server selesai; dapat dilanjutkan atau diputar ulang
  • failed: Travel gagal
  • completed: Travel telah berakhir; artifacts dapat dikueri
rtcStatus stringStatus streaming RTC sisi server; berbeda dari clientStreamStatus yang dilaporkan oleh klien.updateTime stringWaktu pembaruan terakhir, dalam format ISO 8601.userInstructions arrayDaftar instruksi teks; null jika tidak ada data. Setiap item berisi instruction, relativeStartTimeMs / relativeEndTimeMs (milidetik relatif), startTime / endTime (detik linimasa), dan status.chapters arrayDaftar bab; null jika deteksi bab belum dipicu. Setiap item berisi chapterId, title, brief, actRange, startTime, endTime, dan chapterImage.characterActions arrayDitetapkan sebagai array kosong untuk model Directing.environmentActions arrayDitetapkan sebagai array kosong untuk model Directing.

Status prasyarat dan catatan pemanggilan

  • Lakukan polling setiap 2–5 detik.
  • Dalam status running, Anda dapat memanggil endpoint kontrol yang didukung sesuai dengan creationModel: mode standar mendukung instruct, pause, resume, rewind, dan end; mode skrip mendukung update-script, pause, resume, rewind, dan end.
  • Endpoint ini tidak mengembalikan mode, aspectRatio, 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.

Kode kesalahan

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

Langkah selanjutnya

Saat Travel berstatus running atau paused:
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