Skip to main content

HappyOyster-Acting-Send Process Instruction APIリファレンス

Acting Travelに単一のテキスト指示を送信して、後続のロールプレイとフレーム生成を駆動します。Travelが実行中または一時停止中に呼び出し可能です。

スコープ

Acting Travelに単一のテキスト指示を送信して、後続のロールプレイとフレーム生成を駆動します。呼び出す前に、以下を確認してください：
  • 認証：プライマリ API キーは必須ではありません。プライマリまたは一時 API キーのいずれかで呼び出せます。取得方法については、認証情報の取得 を参照してください。
  • 前提条件：Travelの状態はrunningまたはpausedである必要があります。Query Travel Statusで確認してください。
  • 呼び出し元：サーバーまたはクライアントのいずれからも呼び出すことができます。

HTTP リクエスト

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

リクエストパラメーター

  • 処理指示の送信
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/instruct' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "content": "Smile and greet me, and ask how my day is going",
    "clientRequestId": "instruction_greeting_001",
    "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。Enter Travelによって返されます。
content string （必須）テキスト処理指示。空ではなく、最大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": "Smile and greet me, and ask how my day is going",
        "accepted": true
    }
}
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。
message stringエラーメッセージ。成功時は null です。
data objectレスポンスデータ。失敗時は null です。

プロパティ

encryptedTravelId string暗号化されたTravel ID。content string受理された指示テキスト。accepted boolean指示が受理され、処理フローに入ったかどうか。

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

  • Travelの状態はrunningまたはpausedである必要があります。
  • contentは必須であり、空または空白文字のみであってはならず、最大2000文字までです。
  • paused状態で指示を送信すると、指示は受理されますが、Travelは自動的には再開されません。実行を継続する必要がある場合、クライアントは別途Resume Travelを呼び出す必要があります。
  • 同じ論理指示を再試行する際は、重複課金を避けるためにclientRequestIdを再利用してください。
  • 終了または失敗したTravelには書き込みできません。
  • 指示がコンテンツ安全ポリシーに違反した場合、403004が返されます。
  • ActingのcreationModelは常にsimpleであるため、ScriptListサブモードを考慮する必要はありません。

エラーコード

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

次のステップ

指示を送信した後：