HappyOyster-Directing-End Travel APIリファレンス - Alibaba Cloud Model Studio

Directing Travelを終了します。正常終了後はステータスがcompletedに変化し、アーティファクト処理に入ります。無ストリームタイムアウトによる終了時はfailedに変化し、リプレイ用アーティファクトは生成されません。

スコープ

Directingトラベルを終了します。正常終了後はステータスがcompletedに変わり、アーティファクト処理に入ります。ストリームなしのタイムアウト終了時はfailedに変わり、リプレイアーティファクトは生成されません。呼び出す前に、以下を確認してください。

認証：プライマリ API キーは必須ではありません。プライマリまたは一時 API キーのいずれかで呼び出せます。取得方法については、認証情報の取得を参照してください。
前提条件：Travel はまだ終端状態に入っておらず、サーバーが終了できる状態である必要があります。Travel ステータスのクエリで確認してください。
呼び出し元：サーバーまたはクライアントのいずれからも呼び出すことができます。

HTTP リクエスト

Singapore

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/end

{WorkspaceId} を実際のワークスペースID に置き換えます。

米国（バージニア）

POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/end

{WorkspaceId} を実際のワークスペースID に置き換えます。

リクエストパラメーター

正常終了

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/end' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "your-client/1.2.0"
}'

ストリームなしタイムアウト終了

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/end' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "failCode": "TRAVEL_NO_STREAM_AUTO_END",
    "userAgent": "your-client/1.2.0"
}'

Content-Typestring（必須）

リクエストのコンテンツタイプ。このパラメータは application/json に設定する必要があります。

Authorization string （必須）

API キー認証です。プライマリ API キーは必須ではなく、プライマリまたは一時 API キーのいずれかで呼び出せます。

プライマリ API Key：sk- で始まります（例：sk-xxx）。
一時 API キー：st- で始まり、例は st-xxx です。

リクエストボディ

encryptedTravelId string （必須）

終了対象のDirecting暗号化トラベルIDです。トラベルへの入室によって返されます。

failCode string （任意）

失敗終了の理由。省略された場合は正常終了として扱われます。現在サポートされているのは以下の通りです。

TRAVEL_NO_STREAM_AUTO_END：入室後、noStreamAutoEndTimeoutSec を超えてもストリームを受信できなかった場合のシナリオ用です。この終了タイプではリプレイアーティファクトは生成されません。

サポートされていない値を渡すと 400000 が返されます。

userAgent string （任意）

SDK またはクライアントのバージョン識別子です。空でない文字列であり、HTTP User-Agent よりも優先されます。

レスポンスパラメーター

正常終了

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "completed",
        "endedAt": "2026-06-04T00:03:00Z",
        "durationSec": 180
    }
}

ストリームなしタイムアウト終了

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "failed",
        "errorCode": "TRAVEL_NO_STREAM_AUTO_END",
        "errorMessage": "Something went wrong.",
        "endedAt": "2026-06-04T00:03:00Z",
        "durationSec": null
    }
}

code integer

リターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。

message string

エラーメッセージ。成功時は null です。

data object

レスポンスデータ。失敗時は null です。

プロパティ

encryptedTravelId string

終了した Travel の暗号化された Travel ID。

status string

終了ステータス：completed（正常終了） / failed（サポートされているfailCodeが提供された場合の失敗終了）。

errorCode string

失敗理由コード。正常終了時は null です。

errorMessage string

失敗の説明。正常終了時は null です。

endedAt string

終了時刻。ISO 8601 形式です。

durationSec integer

有効な動画の長さ（秒）。ストリームなしの失敗終了時、または長さをまだ解析できない場合は null になります。

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

クライアントは入室後、Travel Statusのクエリをポーリングする必要があります。noStreamAutoEndTimeoutSec以内にrtcStatusがストリーミング状態に入らなかった場合は、TRAVEL_NO_STREAM_AUTO_ENDで終了してください。
TRAVEL_NO_STREAM_AUTO_ENDを渡した後、トラベルはfailedとなり、リプレイアーティファクトを照会できなくなります。
正常終了時、durationSecは最終的な動画ファイルの長さを優先的に使用します。最終的な動画がまだ利用できない場合は、現在利用可能な最新の生成結果のdurationMsを使用します。どちらも利用できない場合はnullとなります。
正常終了がcompletedに達した後でも、アーティファクトの合成が進行中の場合があります。Travel Artifactsのクエリの返却ステータスに基づいて、ポーリングを継続するかどうかを判断してください。

エラーコード

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

次のステップ

Travel が completed 状態になった後：

Travel アーティファクトのクエリ：ポーリングして、記録されたオリジナルおよび合成済みバリアントを取得します。
Travel リストのクエリ：過去の Travel を表示します。