リアルタイムディレクティングワールドを作成します。標準モード(自然言語プロンプト)とスクリプトモード(構造化ScriptList)をサポートしており、APIは暗号化されたワールドIDを即座に返し、ワールドはバックグラウンドで非同期にビルドされ、クライアントは完了までビルド進捗をポーリングします。
スコープ
ディレクティングワールドを作成します。呼び出す前に、以下を確認してください。
-
認証:プライマリ API Key のみがサポートされています。一時的な API Key は使用できません(エラーコード
403003)。- プライマリ API Key を取得する:API Key の取得と設定。
-
呼び出しモード:非同期モードを推奨します。
- 非同期モード(デフォルト):
async=trueの場合、API は即座にencryptedWorldIdを返します。進捗状況については World 構築ステータスのクエリをポーリングしてください。 - 同期モード:
async=falseの場合、サーバーは内部でポーリングを行い(3 秒ごと、最大 120 秒)、構築が完了すると応答を返します。タイムアウト時は非同期にフォールバックし、クライアントがポーリングを継続します。
- 非同期モード(デフォルト):
-
エンドポイントの制限:このエンドポイントはDirectingワールドのみを作成できます。
modeを渡す必要はありません(サーバーは2を書き込みます。2以外の値を渡すと400000が返されます)。creationModelはsimple(標準モード、デフォルト)とscriptlist(スクリプトモード)をサポートします。入室バージョンはstoryV2に固定されており、aspectRatioとmaxExperienceTimeSecはnullに固定されています。
HTTP リクエスト
- Singapore
- 米国(バージニア)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds{WorkspaceId} を実際の ワークスペースID に置き換えます。標準モード(creationModel=simple)
リクエストパラメーター |
|
Content-Typestring(必須)リクエストのコンテンツタイプ。このパラメータは application/json に設定する必要があります。 | |
Authorization string (必須)API Key 認証。プライマリ API Key のみがサポートされており、sk- で始まります(例:sk-xxx)。通常、環境変数 $DASHSCOPE_API_KEY として設定されます。一時的な API Key(st- で始まる)を使用すると 403003 が返されます。 | |
リクエストボディ | |
async boolean (任意)非同期で作成するかどうか。デフォルトは true です:
| |
creationModel string (任意)作成サブモード。標準モード(デフォルト)の場合はsimpleを渡してください。自然言語のpromptを提供すると、サーバーが完全な45ビートのスクリプト、最初のフレーム(ユーザーが提供することも可能)、およびキャラクター参照画像を生成します。ワールド作成後、トラベルフェーズ中に以下の制御エンドポイントを呼び出すことができます。
| |
eventStyle string (任意)creationModel=simpleにのみ適用されます:スクリプト生成テンプレートを選択します。デフォルトはnormalです。許容値:
| |
refWorldId string (任意)既存のDirectingワールドから新しい作品を派生させます。現在のプライマリアカウント配下のDirecting暗号化ワールドIDである必要があります。別のモデルまたは別のプライマリアカウントのワールドを指定すると403001が返されます。 | |
prompt string (必須)ワールドのテーマ説明。中国語と英語に対応しています。空ではなく、最大2000文字です。 | |
resolution string (必須)動画解像度。許容値:
| |
layout string (任意)カメラムーブメントスタイル(カメラの動き方とカットの強さ)。許容値:
| |
narrative string (任意)ナラティブスタイル(ドラマの密度と感情の強さ)。許容値:
| |
firstFrameImage object (任意)提供された場合、ワールドの最初のフレームとして直接再利用され、AIによる初回フレーム生成はスキップされます。urlとbase64は排他的(いずれか一方を選択)です。画像の制約:
プロパティ url string (条件付き必須)最初のフレーム画像URL。制約事項:
string (条件付き必須)最初のフレーム画像base64。制約事項:
string (任意)参照画像タイプ。デフォルトはdefaultです。 | |
inputImages array (任意)スクリプト生成およびキャラクター参照画像に使用され、最大6枚の画像を指定でき、firstFrameImageとは独立しています。各配列項目について、urlとbase64は排他的(いずれか一方を選択)です。画像の制約:
プロパティ url string (条件付き必須)画像URL。制約事項:
string (条件付き必須)画像base64。制約事項:
string (任意)参照画像タイプ。デフォルトはdefaultです。 |
スクリプトモード(creationModel=scriptlist)
リクエストパラメーター |
|
Content-Typestring(必須)リクエストのコンテンツタイプ。このパラメータは application/json に設定する必要があります。 | |
Authorization string (必須)API Key 認証。プライマリ API Key のみがサポートされており、sk- で始まります(例:sk-xxx)。通常、環境変数 $DASHSCOPE_API_KEY として設定されます。一時的な API Key(st- で始まる)を使用すると 403003 が返されます。 | |
リクエストボディ | |
async boolean (任意)非同期で作成するかどうか。デフォルトは true です:
| |
creationModel string (任意)作成サブモード。スクリプトモードの場合はscriptlistを渡してください。構造化されたスクリプトを提供すると、サーバーはスクリプトを生成せず、組み立てと永続化のみを行います。ワールド作成後、トラベルフェーズ中に以下の制御エンドポイントを呼び出すことができます。
instruct(テキストプロセス指示の送信)はサポートされていません。各エンドポイントの説明については、補足事項を参照してください。eventStyleはスクリプトリスト作成では使用されないため、渡さないでください。 | |
refWorldId string (任意)既存のDirectingワールドから新しい作品を派生させます。現在のプライマリアカウント配下のDirecting暗号化ワールドIDである必要があります。別のモデルまたは別のプライマリアカウントのワールドを指定すると403001が返されます。 | |
resolution string (必須)動画解像度。許容値:
| |
firstFrameImage object (必須)World の最初のフレームとして直接再利用される画像参照です。url と base64 は排他的です(いずれか一方を選択してください)。画像の制約事項:
プロパティ url string (条件付き必須)最初のフレーム画像URL。制約事項:
string (条件付き必須)最初のフレーム画像base64。制約事項:
string (任意)参照画像タイプ。デフォルトはdefaultです。 | |
scriptList object (必須)構造化スクリプト。synopsisと空でないactsを含める必要があります。
プロパティ synopsis string (必須)ストーリーのあらすじ。空でないこと、最大2000文字。videoTitle string (任意)ワールド名。デフォルトはNew World、最大128文字。scene string (任意)シーンの設定。デフォルトはStatic Shot、最大64文字。style string (任意)ビジュアルスタイル。デフォルトはStable、最大64文字。speed string (任意)ナラティブのペース。デフォルトはSteady、最大64文字。language string (任意)スクリプト言語。デフォルトはen(英語)です。中国語の場合はzhを渡してください。最大64文字です。setting string (任意)世界観または背景設定。最大2000文字。soundtrack string (任意)サウンドトラックの説明。最大500文字。prologue string (任意)オープニングプロローグ。最大1000文字。videoTags array<string> (任意)動画タグ。最大20個のタグ、各タグは最大32文字。subjects array<object> (任意)事前定義された被写体で、最大6個まで指定できます。各配列項目には以下のプロパティが含まれます。
subjects[]のプロパティ label string (任意)acts[].content内の被写体を参照します。[character_x]という形式で、デフォルトでは配列順に割り当てられます。name string (任意)人間が読める名前であり、画面テキストとしてはレンダリングされません。最大64文字です。type string (任意)被写体のタイプ。デフォルトはcharacterです。被写体の外観および他のプロパティの入力方法を決定します。許容値:
object (任意)被写体の参照画像。urlとbase64は排他的(いずれか一方を選択)であり、画像は厳密に6 MB未満である必要があります。
refImageのプロパティ url string (条件付き必須)被写体参照画像URL。base64 string (条件付き必須)被写体参照画像base64。referenceType string (任意)参照画像タイプ。デフォルトはdefaultです。string (任意)性別の説明。最大64文字。position string (任意)画面上の位置。最大64文字。ethnicity string (任意)民族または人種の説明。最大64文字。age string (任意)年齢の説明。最大64文字。appearance string (任意)外見の詳細。最大500文字。voice string (任意)声、話す速さ、音量の説明。最大200文字。array<object> (必須)ビートごとのスクリプトで、1~45エントリ、すべてのcontentの合計は100000文字以内です。各配列項目には以下のプロパティが含まれます。
acts[]のプロパティ turn int (任意)ターン番号。1~45の範囲で重複不可、デフォルトでは配列順に1からインクリメントされます。content string (必須)このビートのスクリプトです。空ではなく、ビートあたり最大2000文字で、[character_x]を使用して被写体を参照できます。cameraType string (任意)カメラタイプ(カメラの撮影方法)。デフォルトはStaticです。許容値:
string (任意)ショットサイズ。デフォルトはMediumです。このビートで表現できる詳細度を決定します。カットを通じてショットサイズを変更し、同じビート内で全身と指先の両方を記述しないでください。許容値:
cut-inでClose-upにし、次にcut-outでワイドショットに戻ります。ほとんどのビートでlong-takeを使用して同じショットサイズを維持し、ショットサイズの頻繁な切り替えを避けてください。cut string (任意)カット方法(このビートのカットイン方法)。デフォルトはlong-takeです。許容値:
|
レスポンスパラメーター |
|
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。 | |
message stringエラーメッセージ。成功時は null です。 | |
data objectレスポンスデータ。失敗時は null です。
プロパティ encryptedWorldId string暗号化されたワールドIDで、同期モードと非同期モードの両方で返されます。この値は、後続のビルドステータス照会、ワールド詳細照会、および体験クレデンシャルの交換に使用されます。status string現在の作成ステータス:
stringWorld の最初のフレームの URL。生成前は null です。 |
補足事項
- 文字数カウント:本文書における「最大N文字」の制限は、中国語か英語かに関係なく文字(Unicode文字)単位でカウントされます。漢字、英字、数字、スペース、句読点はそれぞれ1文字としてカウントされます。
-
ScriptList提出要件:ワールド作成時、
actsは45エントリに制限されますが、正確に45である必要はありません。完全な45エントリが必要なのは、トラベル中にupdate-scriptを呼び出す場合のみです。 -
トラベル制御エンドポイント:
creationModelの下にリストされているエンドポイント名は、ワールド作成後のトラベルフェーズ中に呼び出すことができるサーバーサイドのエンドポイントであり、このエンドポイント入力の列挙値ではありません。その意味は以下の通りです。
エラーコード
モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。
次のステップ
作成成功後、以下の操作が可能です:
- World 構築ステータスのクエリ:World が
ready状態になるまで、3~5 秒ごとにポーリングします。 - World が
ready状態になった後、Travel Credential の取得を呼び出して、使い捨てのticketと交換します。 - ワールド詳細の照会:完全な作成メタデータとScriptListを照会します。