Alibaba Cloud Model Studio:HappyOyster-Adventure-Query Travel Artifacts API リファレンス

完了した Adventure Travel の記録済みオリジナルと3つの合成バリアントをクエリします。外部への配信には withInstructionAndWatermark を推奨します。

スコープ

完了した Adventure Travel の記録済みオリジナルと3つの合成バリアントをクエリします。Adventure において、withInstruction はテキスト指示字幕バリアントではなく、探索・インタラクションオーバーレイバリアント を意味します。外部への配信には withInstructionAndWatermark を推奨します。呼び出す前に、以下を確認してください。

• 認証：プライマリ API Key のみがサポートされています。一時的な API Key は使用できません（エラーコード 403003）。

  • プライマリ API Key を取得する：API Key の取得と設定。

• 前提条件：Travelのステータスがcompletedであること。利用可能なオリジナルURLがアーティファクトレスポンスを返すための前提条件となります。Query Travel Statusで確認してください。

• Caller：サーバーから呼び出されます。

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
            }
        }
    }
}

前提条件となるステータスと呼び出しに関する注意事項

• Travel が completed でない場合、存在しない場合、あなたのものでないか Adventure でない場合、またはオリジナルがまだ利用できない場合は、404000 が返されます。オリジナルはこのエンドポイント全体のハードゲートです。
• クライアントは、composeStatus != readyの間、制御された間隔でポーリングできます。
• withInstruction を演出用テキスト字幕として解釈しないでください。Adventure では、これは探索インタラクションオーバーレイです。
• 外部配信の場合はvideo.withInstructionAndWatermarkを参照してください。ビジネスでオリジナルのみが必要な場合は、引き続きvideo.original.urlを参照してください。
• 4つのビデオバリアントは同じ再生時間解析結果を共有するため、1つのレスポンス内で解析可能な再生時間を持つ準備完了のバリアントは一貫した durationSec を返します。
• TRAVEL_NO_STREAM_AUTO_ENDによって終了されたTravelはfailedとなり、クエリ可能なアーティファクトを生成しません。

エラーコード

モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。

次のステップ

• Query Travel List：他の過去のTravelを表示します。
• End Travel：アーティファクトをクエリする前に新しいTravelを終了します。