単一のActing Worldの完全なメタデータおよびエコー可能な作成パラメータをクエリします。ビルド進捗のポーリングには、Query World Build Statusエンドポイントを使用してください。
スコープ
単一のActing Worldの完全なメタデータおよびエコー可能な作成パラメータをクエリします。呼び出し前に以下を確認してください：
-
認証：プライマリ 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-acting/openapi/v1/worlds/detail{WorkspaceId} を実際の ワークスペースID に置き換えます。リクエストパラメーター |
|
Authorization string （必須）API Key 認証。プライマリ API Key のみがサポートされており、sk- で始まります（例：sk-xxx）。通常、環境変数 $DASHSCOPE_API_KEY として設定されます。一時的な API Key（st- で始まる）を使用すると 403003 が返されます。 | |
クエリパラメータ | |
encryptedWorldId string （必須）現在のプライマリアカウント配下のActing暗号化World ID。Create Worldによって返されます。 |
レスポンスパラメーター | Query succeeded |
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。 | |
message stringエラーメッセージ。成功時は null です。 | |
data objectレスポンスデータ。失敗時は null です。
プロパティ encryptedWorldId string暗号化されたWorld ID。name stringWorld名。status stringビルドステータス：generating / ready / failed。mode integerActing では常に 3 です。creationModel stringActing では常に simple です。prompt string作成時に送信された最上位のプロンプト。eventStyle string互換性のために返されるフィールドです。準拠した作成でこのフィールドが省略された場合、サーバーは通常uploadModeからマッピングし、first_frameをエコーします。これはActingの作成パラメータではないため、クライアントはこれを返信しないでください。perspective nullActingはperspective作成パラメータを受け付けません。nullに固定されています。uploadMode stringfirst_frameに固定されています。resolution string480p / 720p。作成時に指定されない場合は480pとなります。aspectRatio string9:16 / 16:9。作成時に指定されない場合は9:16となります。layout nullActingはこの作成パラメータを受け付けません。nullに固定されています。narrative nullActingはこの作成パラメータを受け付けません。nullに固定されています。refWorldId string派生作成に使用されるActingの暗号化参照World ID。noneの場合はnullとなります。firstFrameImage object作成時に必須の初回フレーム画像。URL形式でのみ返され、base64は返されません。urlおよびreferenceTypeを含みます。inputImages nullActingでは現在このフィールドを使用しません。sceneImage nullActingはシーン/ロール画像スロットを使用しません。nullに固定されています。roleImage nullActingはシーン/ロール画像スロットを使用しません。nullに固定されています。scenePrompt nullActingはシーン/ロールプロンプトを使用しません。nullに固定されています。rolePrompt nullActingはシーン/ロールプロンプトを使用しません。nullに固定されています。scriptList nullActingはScriptListをサポートしていません。nullに固定されています。previewUrl null現在はnullに固定されています。createdAt string作成日時。ISO 8601形式です。updatedAt string最終更新時刻です。ISO 8601形式です。 |
前提条件となるステータスと呼び出しに関する注意事項
- このエンドポイントは
generating、ready、またはfailed状態のWorldをクエリできます。準備が整う前のビルド成果物はnullとなる場合があります。 - 詳細エンドポイントは
asyncをエコーしません。これはWorldの属性ではなく、呼び出し動作の切り替えであるためです。 - 画像はURLおよび
referenceTypeとしてのみ返されます。作成リクエスト内のbase64コンテンツは返されません。 eventStyleは通常uploadModeと同じ値になります。クライアントはActing作成モードの信頼できるフィールドとしてuploadModeを扱う必要があります。- プレーヤーは
aspectRatioを事前読み込みできますが、実際にルームに入る際は、Enter Travelのレスポンス値から向きを設定する必要があります。 - 別のモデル、別のプライマリアカウント、または削除済みのWorldをクエリした場合、いずれも
403001が返され、リソースが存在するかどうかは開示されません。
エラーコード
モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。
次のステップ
- Query World List：すべてのActing Worldをページネーションで取得します。
- Delete World：不要になったWorldを削除します。
- Worldが
ready状態の場合、Get Travel Credentialを実行できます。