Skip to main content

HappyOyster-Acting-End Travel API リファレンス

Acting Travel を能動的に終了します。正常終了後は completed に入り、アーティファクトの処理を開始します。ストリームなしタイムアウト終了の場合は failed に入り、リプレイアーティファクトは生成されません。

スコープ

Acting Travel を能動的に終了します。正常終了後、Travel は completed に入り、アーティファクトの処理を開始します。ストリームなしタイムアウト終了の場合は failed に入り、リプレイアーティファクトは生成されません。呼び出す前に、以下を確認してください：
  • 認証：プライマリ API キーは必須ではありません。プライマリまたは一時 API キーのいずれかで呼び出せます。取得方法については、認証情報の取得 を参照してください。
  • 前提条件：Travel はまだ終端状態に入っておらず、サーバーが終了できる状態である必要があります。Travel ステータスのクエリ で確認してください。
  • 呼び出し元：サーバーまたはクライアントのいずれからも呼び出すことができます。

HTTP リクエスト

  • Singapore
  • 米国（バージニア）
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/end{WorkspaceId} を実際の ワークスペースID に置き換えます。

リクエストパラメーター

  • 正常終了
  • ストリームなしタイムアウト終了
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/end' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "HappyOyster-Web/1.2.0"
}'
Content-Typestring（必須）リクエストのコンテンツタイプ。このパラメータは application/json に設定する必要があります。
Authorization string （必須）API キー認証です。プライマリ API キーは必須ではなく、プライマリまたは一時 API キーのいずれかで呼び出せます。
  • プライマリ API Key：sk- で始まります（例：sk-xxx）。
  • 一時 API キー：st- で始まり、例は st-xxx です。
リクエストボディ
encryptedTravelId string （必須）終了対象の Acting 暗号化 Travel ID です。Travel への入室 によって返されます。
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-09-09T08:33:00Z",
        "durationSec": 180
    }
}
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。
message stringエラーメッセージ。成功時は null です。
data objectレスポンスデータ。失敗時は null です。

プロパティ

encryptedTravelId string終了した Travel の暗号化された Travel ID。status string終了ステータス：
  • completed：正常終了
  • failed：サポートされている failCode が提供された場合の失敗終了
errorCode string失敗理由コード。失敗終了時のみ返されます。errorMessage string失敗の説明。失敗終了時のみ返されます。endedAt string終了時刻、ISO 8601 形式。まだ利用できない場合は null になることがあります。durationSec integer有効な動画の長さ（秒）。ストリームなしの失敗終了時、または長さをまだ解析できない場合は null になります。

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

  • encryptedTravelId は現在のプライマリアカウントおよび Acting モデルに属している必要があります。
  • Travel はまだ終端状態に入っておらず、サーバーが終了できる状態である必要があります。
  • failCode を省略した場合、正常終了として扱われます。サポートされていない値を渡すと 400000 が返されます。
  • 正常終了時、durationSec は優先的に利用可能な完成動画の実際の長さを使用します。完成動画の長さをまだ解析できない場合は null になることがあります。
  • Acting は maxExperienceTimeSec を使用せず、クライアントがこれを渡してもその時間後に自動終了することはありません。
  • 正常終了後に completed に達しても、合成済みアーティファクトはまだ処理中の可能性があります。Travel アーティファクトのクエリ に従ってクエリおよびポーリングを行ってください。

エラーコード

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

次のステップ

Travel が completed 状態になった後：