HappyOyster-Directing-Send Process Instruction APIリファレンス - Alibaba Cloud Model Studio

標準モードのTravelに単一のテキスト指示を送信し、後続のフレーム生成を駆動します。creationModel=simpleのみがサポートされています。scriptlistのTravelはフルスクリプト更新を使用する必要があります。

スコープ

標準モード（creationModel=simple）のTravelに単一のテキスト指示を送信し、後続のフレーム生成を駆動します。呼び出し前に、以下を確認してください：

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

HTTP リクエスト

Singapore

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

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

米国（バージニア）

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

{WorkspaceId} を実際のワークスペース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": "A giant robot dinosaur suddenly appears",
    "clientRequestId": "instruction_20260909_001",
    "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暗号化済みTravel IDです。creationModelはsimpleである必要があります。Travelへの入室によって返されます。

content string （必須）

テキストによるプロセス指示です。空ではなく最大2000文字までです。空または2000文字を超える場合は400000を返します。

clientRequestId string （任意）

指示再試行のための冪等性キー。同じ指示を再試行する際は、重複課金を避けるために同じ値を再利用してください。推奨フォーマットは[A-Za-z0-9_-]{1,32}です。

省略または不正な形式であってもパラメータエラーは返されません。サーバーはゲートウェイのrequest_idにフォールバックし、それも利用できない場合はランダムな冪等性キーを使用します
このフィールドは課金の重複排除にのみ使用され、指示処理自体が厳密に1回実行されることを保証するものではありません。

userAgent string （任意）

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

レスポンスパラメーター

指示受理済み

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "content": "A giant robot dinosaur suddenly appears",
        "accepted": true
    }
}

code integer

リターンコード。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 エラーコードを参照して解決してください。

次のステップ

指示を送信した後：

Query Travel Status：指示の実行状況とチャプター情報を表示します。
Travelの一時停止 / Travelの再開 / Travelの巻き戻し。
End Travel：セッションを終了し、アーティファクトを処理します。