Referensi API HappyOyster-Adventure-Query Travel Artifacts

​

Cakupan

• Autentikasi: Hanya API Key utama yang didukung; API Key sementara tidak dapat digunakan (kode kesalahan 403003).
  • Dapatkan API Key utama: Mendapatkan dan mengonfigurasi API Key.
• 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

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/artifacts?encryptedTravelId={encryptedTravelId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"

{
    "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": 90
            },
            "withWatermark": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_wm.mp4?v=2",
                "status": "ready",
                "resolution": null,
                "durationSec": 90
            },
            "withInstruction": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_overlay.mp4?v=2",
                "status": "ready",
                "resolution": null,
                "durationSec": 90
            },
            "withInstructionAndWatermark": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_all.mp4?v=2",
                "status": "ready",
                "resolution": null,
                "durationSec": 90
            }
        }
    }
}

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "composeStatus": "processing",
        "video": {
            "original": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_raw.mp4?v=2",
                "status": "ready",
                "resolution": "720p",
                "durationSec": 90
            },
            "withWatermark": {
                "url": null,
                "status": "processing",
                "resolution": null,
                "durationSec": null
            },
            "withInstruction": {
                "url": null,
                "status": "processing",
                "resolution": null,
                "durationSec": null
            },
            "withInstructionAndWatermark": {
                "url": null,
                "status": "processing",
                "resolution": null,
                "durationSec": null
            }
        }
    }
}

​

Status prasyarat dan catatan pemanggilan

• Ketika Travel tidak completed, tidak ada, bukan milik Anda atau bukan Adventure, atau aslinya belum tersedia, maka 404000 akan dikembalikan; materi asli merupakan gerbang utama bagi seluruh endpoint.
• Klien dapat melakukan polling pada interval terkendali sementara composeStatus != ready.
• Jangan menafsirkan withInstruction sebagai subtitle teks pengarahan; dalam Adventure, ini adalah overlay interaksi eksplorasi.
• 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.

​

Kode kesalahan

​

Langkah selanjutnya

• Query Travel List: lihat Travel historis lainnya.
• End Travel: akhiri Travel baru sebelum mengkueri artefaknya.