HappyOyster-Directing-傳送過程指令 API參考 - Alibaba Cloud Model Studio

向普通模式 Travel 傳送一條文字指令，驅動後續畫面生成。僅 creationModel=simple 支援；scriptlist Travel 應使用劇本全量更新。

適用範圍

向普通模式（creationModel=simple）Travel 傳送一條文字指令，驅動後續畫面生成。呼叫前請確認以下事項：

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

HTTP 呼叫

新加坡

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

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

美国（維吉尼亞）

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

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

請求參數

傳送過程指令

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/instruct' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "content": "突然出现一只巨大的机器恐龙",
    "clientRequestId": "instruction_20260909_001",
    "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，creationModel 必須為 simple。由用戶端進入房間介面返回。

content string （必選）

文字過程指令。非空，最長 2000 字；為空或超過 2000 字返回 400000。

clientRequestId string （可選）

指令重試冪等鍵。同一條指令重試時複用同值，以避免重複計費。推薦格式 [A-Za-z0-9_-]{1,32}。

缺省或格式不合法不會返回參數錯誤：伺服器端會回退使用網關 request_id，仍不可用時使用隨機冪等鍵
該欄位僅用於計費去重，不保證指令處理本身只執行一次

userAgent string （可選）

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

回應參數

指令已接受

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "content": "突然出现一只巨大的机器恐龙",
        "accepted": true
    }
}

code integer

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

message string

錯誤訊息。成功時為 null。

data object

回應資料。失敗時為 null。

屬性

encryptedTravelId string

加密的 Travel ID。

content string

已接受的指令文字。

accepted boolean

是否已接受指令並進入處理流程。

前置狀態與呼叫注意事項

僅 creationModel=simple 支援本介面；scriptlist Travel 應使用劇本全量更新，誤呼叫 instruct 返回 403006。
Travel 目前狀態必須可接收指令；已結束或失敗的 Travel 不可寫。
content 為空或超過 2000 字時返回 400000。
建議每次邏輯指令生成穩定的 clientRequestId，重試時複用。
指令未通過內容安全策略時返回 403004。

錯誤碼

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

下一步

傳送指令後：

查詢Travel狀態：檢視指令執行狀態和章節資訊。
暫停Travel / 恢復Travel / 回溯Travel。
結束Travel：結束工作階段並處理產物。