Skip to main content

HappyOyster-Directing-スクリプト更新APIリファレンス

スクリプトモードのTravelにおいて、完全な45ターンのセットを送信し、現在のTravelのactsを完全に置き換えます。creationModel=scriptlistのみがサポートされています。

スコープ

スクリプトモード（creationModel=scriptlist）のTravelにおいて、完全な45ターンのセットを送信し、現在のTravelのactsを完全に置き換えます。呼び出す前に、以下を確認してください：
  • 認証：プライマリ API キーは必須ではありません。プライマリまたは一時 API キーのいずれかで呼び出せます。取得方法については、認証情報の取得 を参照してください。
  • 前提条件：TravelのcreationModelはscriptlistである必要があり、ステータスはrunningまたはpendingである必要があります。Travelステータスの照会で確認してください。
  • 呼び出し元：サーバーまたはクライアントのいずれからも呼び出すことができます。

HTTP リクエスト

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

リクエストパラメーター

  • スクリプトの更新
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/update-script' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "scriptList": {
        "acts": [
            {
                "turn": 1,
                "content": "[character_1] wakes up and looks toward the door.",
                "cameraType": "Static",
                "shotSize": "Medium",
                "cut": "long-take"
            },
            {
                "turn": 2,
                "content": "[character_1] walks slowly across the dark room.",
                "cameraType": "Tracking",
                "shotSize": "Wide",
                "cut": "hard-cut"
            }
        ]
    },
    "userAgent": "your-client/1.2.0"
}'
この例では、構造を説明するためにact 1と2のみを表示しており、そのまま提出してはなりません。実際のリクエストには、すべての45件のエントリを含める必要があり、turnは1〜45で、連続かつ重複があってはなりません。
Content-Typestring（必須）リクエストのコンテンツタイプ。このパラメータは application/json に設定する必要があります。
Authorization string （必須）API キー認証です。プライマリ API キーは必須ではなく、プライマリまたは一時 API キーのいずれかで呼び出せます。
  • プライマリ API Key：sk- で始まります（例：sk-xxx）。
  • 一時 API キー：st- で始まり、例は st-xxx です。
リクエストボディ
encryptedTravelId string （必須）更新対象のDirecting暗号化Travel ID。そのcreationModelはscriptlistである必要があります。Travelへの入場によって返されます。
scriptList object （必須）完全なスクリプトコンテナ。有効なのはactsのみです。subjects、synopsis、scene、style、speed、language、setting、soundtrack、prologue、またはvideoTagsが含まれていても、これらのフィールドは無視され、プラットフォームはWorld作成時に保存された値を引き続き使用します。scriptList.acts array (必須)完全なアクトリスト。制約事項：
  • 正確に45件のエントリである必要があります
  • turnは1〜45を網羅し、連続かつ重複がない必要があります
  • contentは空ではなく、ビートあたり最大2000文字まで。すべてのcontentの合計は最大100000文字まで
  • cameraType（オプション、デフォルトStatic）、shotSize（オプション、Wide / Medium / Close-up、デフォルトMedium）、cut（オプション、デフォルトlong-take）
このエンドポイントは完全置換であり、変更されたターンのみの送信はサポートしていません。
userAgent string （任意）SDK またはクライアントのバージョン識別子です。空でない文字列であり、HTTP User-Agent よりも優先されます。

レスポンスパラメーター

  • 更新が受理されました
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "accepted": true,
        "turnCount": 45
    }
}
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。
message stringエラーメッセージ。成功時は null です。
data objectレスポンスデータ。失敗時は null です。

プロパティ

encryptedTravelId string暗号化されたTravel ID。accepted boolean完全なスクリプトが受け入れられ、処理フローに入ったかどうかを示します。turnCount integerこの完全更新におけるターン数。45に固定されています。

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

  • このエンドポイントをサポートするのはcreationModel=scriptlistのみです。標準モードのTravelが誤ってこれを呼び出した場合、409000が返されます。
  • Travelステータスはrunningまたはpendingである必要があります。
  • actsは正確に45件のエントリである必要があります。turnは1〜45で、連続かつ重複がない必要があります。そうでない場合、400000が返されます。
  • コンテンツ安全ポリシーに違反するスクリプト内容は403004を返します。著作権またはIPコンプライアンスによる拒否は403005を返します。

エラーコード

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

次のステップ

更新後：