単一のDirecting Worldの現在のステータス、作成パラメータ、および返却可能なScriptList情報を照会します。ビルド進捗のポーリングを行う場合は、Worldビルドステータス照会エンドポイントを使用してください。
スコープ
単一のDirecting Worldの現在のステータス、作成パラメータ、および返却可能なScriptList情報を照会します。呼び出す前に、以下を確認してください:
-
認証:プライマリ API Key のみがサポートされています。一時的な API Key は使用できません(エラーコード
403003)。- プライマリ API Key を取得する:API Key の取得と設定。
-
前提条件:Create World によって返された
encryptedWorldIdを使用してクエリします。構築進捗のポーリングには Query World Build Status を使用してください。 - Caller:サーバーから呼び出されます。
HTTP リクエスト
- Singapore
- 米国(バージニア)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/detail{WorkspaceId} を実際の ワークスペースID に置き換えます。リクエストパラメーター |
|
Authorization string (必須)API Key 認証。プライマリ API Key のみがサポートされており、sk- で始まります(例:sk-xxx)。通常、環境変数 $DASHSCOPE_API_KEY として設定されます。一時的な API Key(st- で始まる)を使用すると 403003 が返されます。 | |
クエリパラメータ | |
encryptedWorldId string (必須)現在のプライマリアカウント配下のDirecting暗号化World ID。Worldの作成によって返されます。 |
レスポンスパラメーター |
|
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。 | |
message stringエラーメッセージ。成功時は null です。 | |
data objectレスポンスデータ。失敗時は null です。
プロパティ encryptedWorldId string暗号化されたWorld ID。name stringWorld名。status stringビルドステータス:generating / ready / failed。mode integerDirectingの場合は常に2です。creationModel stringsimple / scriptlist。Travelが呼び出せる制御エンドポイントを決定します。prompt stringsimpleモードで作成時に使用されたPrompt。scriptlistの場合はnullに固定されます。eventStyle string作成時のイベントスタイル:normal / dramatic / regular。perspective nullDirectingモデルでは通常nullです。uploadMode nullDirecting Worldでは通常nullです。resolution string480p / 720p.layout stringsimpleモードのカメラムーブメントスタイル。未指定の場合やscriptlistの場合は通常nullです。narrative stringsimpleモードのナラティブスタイル。未指定の場合やscriptlistの場合は通常nullです。refWorldId string派生作成に使用される暗号化参照World ID。firstFrameImage object作成時の最初のフレーム画像。レスポンスではbase64は返されません。inputImages arraysimpleモードで作成時に永続化された参照画像。scriptlistはこのフィールドを受け付けないため、通常はnullとなります。scriptList objectscriptlist Worldの場合にのみ値を持ちます。構造化スクリプトのパースに失敗した場合はnullとなります。synopsis、videoTitle、scene、style、speed、language、setting、soundtrack、prologue、videoTags、subjects(label/name/type/refImageなどを含む)、およびacts(保存内容に基づいて完全に返され、turn/content/cameraType/shotSize/cutを含む)が含まれます。previewUrl null現在はnullに固定されています。aspectRatio nullDirectingモデルではnullに固定されています。createdAt string作成日時。ISO 8601形式です。updatedAt string最終更新時刻です。ISO 8601形式です。 |
前提条件となるステータスと呼び出しに関する注意事項
- このエンドポイントは、
generating、ready、またはfailed状態のWorldを照会できます。 - 作成リクエストの
asyncフィールドはエコーされません。 - 画像フィールドはURLと
referenceTypeのみを返し、base64は決して返しません。simpleモードのinputImagesは参照画像として永続化され、詳細情報として返却可能です。scriptlistはこのフィールドを受け付けません。 scriptListが正常にパースされた場合、保存された完全な構造が返され、actsも保存内容に基づいて完全に返されます。パースに失敗した場合はscriptList=nullが返され、空のactsを使用してパース失敗を示すことはありません。- 別のモデル、別のプライマリアカウント、または削除済みのWorldをクエリした場合、いずれも
403001が返され、リソースが存在するかどうかは開示されません。
エラーコード
モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。
次のステップ
- Worldリストの照会:すべてのDirecting Worldをページネーションで取得します。
- Delete World:不要になったWorldを削除します。
- Worldが
ready状態の場合、Get Travel Credentialを実行できます。