Skip to main content
Referensi Open API Acting

Referensi API HappyOyster-Acting-Query Travel Artifacts

Kueri rekaman asli dan tiga varian komposit dari Travel Acting yang telah selesai. Untuk pengiriman eksternal, withInstructionAndWatermark direkomendasikan.

Cakupan

Kueri rekaman asli dan tiga varian komposit dari Travel Acting yang telah selesai. withInstruction adalah varian overlay dari instruksi proses pengguna; untuk pengiriman eksternal, withInstructionAndWatermark direkomendasikan. Sebelum memanggil, konfirmasikan hal berikut:
  • Autentikasi: Hanya API Key utama yang didukung; API Key sementara tidak dapat digunakan (kode kesalahan 403003).
  • Prasyarat: Status Travel adalah completed. URL asli yang tersedia merupakan prasyarat untuk mengembalikan respons artifacts. Konfirmasikan melalui Query Travel 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-acting/openapi/v1/travels/artifactsGanti {WorkspaceId} dengan ID Workspace Anda yang sebenarnya.

Parameter permintaan

  • Kueri artifacts Travel
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/artifacts?encryptedTravelId={encryptedTravelId}' \
    -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
encryptedTravelId string (Wajib)ID Travel terenkripsi Acting dengan status completed. Dikembalikan oleh Enter Travel.

Parameter respons

  • Keempat artifacts siap
  • Komposisi masih diproses
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "composeStatus": "ready",
        "video": {
            "original": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_raw.mp4?v=2",
                "status": "ready",
                "resolution": "720p",
                "durationSec": 180
            },
            "withWatermark": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_wm.mp4?v=2",
                "status": "ready",
                "resolution": null,
                "durationSec": 180
            },
            "withInstruction": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_overlay.mp4?v=2",
                "status": "ready",
                "resolution": null,
                "durationSec": 180
            },
            "withInstructionAndWatermark": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_all.mp4?v=2",
                "status": "ready",
                "resolution": null,
                "durationSec": 180
            }
        }
    }
}
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.composeStatus stringStatus agregat dari tiga varian komposit:
  • ready: withWatermark, withInstruction, dan withInstructionAndWatermark semuanya ready
  • partial: setidaknya satu varian komposit adalah ready, tetapi tidak semuanya
  • processing: none dari tiga varian komposit adalah ready
Ini hanya mengagregasi tiga varian komposit dan tidak mencakup original.video objectEmpat varian tetap dari video utama. Setiap item berisi url, status, resolution, dan durationSec.
  • original: rekaman asli; representasi 720p dikembalikan secara prioritas jika tersedia
  • withWatermark: varian komposit khusus watermark
  • withInstruction: varian komposit dengan overlay instruksi-proses pengguna
  • withInstructionAndWatermark: varian komposit overlay instruksi-proses pengguna + watermark, direkomendasikan untuk pengiriman eksternal
video.*.url stringURL unduhan; null saat processing atau unavailable.video.*.status stringStatus per item:
  • ready: siap, url dapat diakses
  • processing: masih melakukan kompositing, url=null
  • unavailable: kompositing gagal atau URL tidak tersedia untuk sementara, url=null
video.*.resolution string"720p" saat original cocok dengan 720p; jika tidak, nilainya mungkin null.video.*.durationSec integerDurasi video yang diparsing secara seragam dalam detik; jika dapat diparsing, semua varian ready akan membawa nilai ini. Nilainya mungkin null saat processing / unavailable atau saat durasi belum dapat diparsing.

Status prasyarat dan catatan pemanggilan

  • Klien dapat melakukan polling pada interval terkendali sementara composeStatus != ready.
  • video.withInstruction adalah varian overlay instruksi-proses, bukan asli tanpa instruksi.
  • Untuk pengiriman eksternal, baca video.withInstructionAndWatermark; jika bisnis Anda hanya memerlukan versi asli, lanjutkan membaca video.original.url.
  • Keempat varian video memiliki hasil parsing durasi yang sama, sehingga dalam satu respons, varian yang siap dengan durasi yang dapat di-parse akan mengembalikan nilai durationSec yang konsisten.
  • Travel yang diakhiri oleh TRAVEL_NO_STREAM_AUTO_END berstatus failed dan tidak menghasilkan artefak yang dapat dikueri.
  • Jangan selalu menampilkan 404000 sebagai "belum selesai": baca terlebih dahulu status dan errorCode melalui Query Travel Status atau Query Travel List; untuk Travel yang failed, tampilkan alasan kegagalan.
Skenario 404000
SkenarioPerilaku endpoint
Travel masih berlangsung (init / pending / running / paused)Mengembalikan kode bisnis 404000, dengan message = Video is still being generated, please try again once the process is complete
Travel berstatus failedMengembalikan kode bisnis 404000, dengan message = Experience failed and no video was produced (errorCode=<errorCode>): <errorMessage>; kegagalan bersifat final dan tidak ada video yang akan dihasilkan
Travel tidak ada, bukan milik Anda, atau bukan ActingMengembalikan kode bisnis 404000
URL asli tidak tersediaMengembalikan kode bisnis 404000; versi asli merupakan gerbang utama bagi seluruh endpoint
Versi asli siap dan komposisi masih diprosesHTTP 200; item komposit yang sesuai memiliki status=processing, url=null
Komposisi gagal atau URL sementara tidak tersediaHTTP 200; item komposit yang sesuai memiliki status=unavailable, url=null

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