HappyOyster-Directing-恢復 Travel API 參考 - Alibaba Cloud Model Studio

恢復已暫停的 Directing Travel，使其重新進入運行狀態。

適用範圍

恢復已暫停的 Directing Travel，使其重新進入運行狀態。調用前請確認以下事項：

驗證要求：不強制主 API Key，主 API Key 或臨時 API Key 均可呼叫。獲取方式請參閱獲取驗證憑證。
前置條件：Travel 必須已透過查詢Travel狀態确认為 paused。
呼叫方：您的伺服器端或用戶端均可呼叫。

HTTP 呼叫

新加坡

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

呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。

美国（維吉尼亞）

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

呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。

請求參數

恢復Travel

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

Content-Typestring（必選）

請求內容類型。此參數必須設定為 application/json。

Authorization string （必選）

API Key 驗證。不強制使用主 API Key，主 API Key 或臨時 API Key 均可呼叫。

主 API Key：以 sk- 開頭，如 sk-xxx。
臨時 API Key：以 st- 開頭，如 st-xxx。

請求主體（Request Body）

encryptedTravelId string （必選）

要恢復的 Directing 加密 Travel ID。由客戶端進入房間接口返回。

userAgent string （可選）

SDK 或用戶端版本識別碼。非空字串，優先於 HTTP User-Agent。

回應參數

恢復成功

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "running"
    }
}

code integer

返回碼。0 表示成功，非 0 為錯誤碼。

message string

錯誤訊息。成功時為 null。

data object

回應資料。失敗時為 null。

屬性

encryptedTravelId string

加密的 Travel ID。

status string

恢復後的狀態，返回 running。

前置狀態與呼叫注意事項

Travel 必須已透過查詢Travel狀態確認為 paused。
進房回應中的 version 必須為 storyV2。
已結束或失敗的 Travel 不能恢復。

錯誤碼

如果模型呼叫失敗並返回錯誤訊息，請參閱 HappyOyster 錯誤碼進行解決。

下一步

恢復後可進行以下操作：

查詢Travel狀態：確認 Travel 回到 running。
普通模式：傳送過程指令。
劇本模式：劇本全量更新。
結束Travel：結束工作階段並處理產物。