Skip to main content
Referensi Open API Directing

Referensi API HappyOyster-Directing-Query Travel Artifacts

Kueri rekaman asli dan tiga varian terkombinasi dari Directing Travel yang telah selesai. Ketersediaan asli merupakan prasyarat untuk mengembalikan respons artefak; untuk distribusi eksternal, withInstructionAndWatermark direkomendasikan.

Cakupan

Kueri rekaman asli dan tiga varian terkombinasi dari Directing Travel yang telah selesai. Ketersediaan asli merupakan prasyarat untuk mengembalikan respons artefak; varian terkombinasi mungkin masih diproses. Untuk distribusi eksternal, withInstructionAndWatermark direkomendasikan. Sebelum memanggil, konfirmasi hal berikut:
  • Autentikasi: Hanya API Key utama yang didukung; API Key sementara tidak dapat digunakan (kode kesalahan 403003).
  • Prasyarat: Status Travel adalah completed. Ketersediaan asli merupakan prasyarat untuk mengembalikan respons artefak. Konfirmasi 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-directing/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-directing/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 Directing 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 artefak video jalur utama, dengan struktur bidang yang tetap. Setiap item berisi url, status, resolution, dan durationSec.
  • original: rekaman asli; representasi 720p lebih diutamakan
  • withWatermark: varian komposit khusus watermark
  • withInstruction: varian terkombinasi dengan subtitle instruksi pengguna saja
  • withInstructionAndWatermark: varian terkombinasi dengan subtitle instruksi pengguna dan watermark, direkomendasikan untuk distribusi eksternal
video.*.url stringURL video; null ketika status=processing.video.*.status stringStatus per item:
  • ready: video siap dan URL dapat diakses
  • processing: masih diproses; url adalah null
  • unavailable: komposisi gagal atau URL sementara tidak tersedia
video.*.resolution stringvideo.original.resolution adalah "720p" ketika aslinya cocok dengan 720p; jika tidak, nilainya 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

  • Ketika Travel tidak completed, tidak ada, bukan milik Anda atau bukan Directing, atau aslinya tidak tersedia, 404000 dikembalikan; ketersediaan asli merupakan prasyarat untuk mengembalikan respons artefak.
  • Ketika Anda memerlukan semua varian terkombinasi, Anda dapat terus melakukan polling selama composeStatus != ready.
  • video.withInstructionAndWatermark adalah varian yang direkomendasikan untuk distribusi eksternal.
  • 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.

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