HappyOyster-Directing-World詳細照会APIリファレンス - Alibaba Cloud Model Studio

単一の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 に置き換えます。

米国（バージニア）

GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/detail

{WorkspaceId} を実際のワークスペースID に置き換えます。

リクエストパラメーター	World詳細のクエリ `curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/detail?encryptedWorldId={encryptedWorldId}' \ -H "Authorization: Bearer $DASHSCOPE_API_KEY"`
Authorization `string` （必須） API Key 認証。プライマリ API Key のみがサポートされており、`sk-` で始まります（例：`sk-xxx`）。通常、環境変数 `$DASHSCOPE_API_KEY` として設定されます。一時的な API Key（`st-` で始まる）を使用すると `403003` が返されます。
クエリパラメータ
encryptedWorldId `string` （必須）現在のプライマリアカウント配下のDirecting暗号化World ID。Worldの作成によって返されます。

レスポンスパラメーター

照会成功（スクリプトモード）

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "name": "Midnight Visitor",
        "status": "ready",
        "mode": 2,
        "creationModel": "scriptlist",
        "prompt": null,
        "eventStyle": "normal",
        "perspective": null,
        "uploadMode": null,
        "resolution": "720p",
        "layout": null,
        "narrative": null,
        "refWorldId": null,
        "firstFrameImage": {
            "url": "https://cdn.happyoyster.com/frames/room.png",
            "referenceType": "default"
        },
        "inputImages": null,
        "scriptList": {
            "synopsis": "Late at night, Su Li is startled awake by a knock at the door.",
            "videoTitle": "Midnight Visitor",
            "subjects": [
                {
                    "label": "[character_1]",
                    "name": "Su Li",
                    "type": "character",
                    "refImage": {
                        "url": "https://cdn.happyoyster.com/subjects/suli.png",
                        "referenceType": "default"
                    }
                }
            ],
            "acts": [
                {
                    "turn": 1,
                    "content": "Rain beats against the window, and [character_1] is startled awake from sleep.",
                    "cameraType": "Static",
                    "shotSize": "Wide",
                    "cut": "long-take"
                },
                {
                    "turn": 2,
                    "content": "[character_1] walks toward the door, and the knocking sounds again outside.",
                    "cameraType": "Push-in",
                    "shotSize": "Close-up",
                    "cut": "long-take"
                }
            ]
        },
        "previewUrl": null,
        "aspectRatio": null,
        "createdAt": "2026-06-03T10:00:00Z",
        "updatedAt": "2026-06-03T10:05:00Z"
    }
}

code integer

リターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。

message string

エラーメッセージ。成功時は null です。

data object

レスポンスデータ。失敗時は null です。

プロパティ

encryptedWorldId string

暗号化されたWorld ID。

name string

World名。

status string

ビルドステータス：generating / ready / failed。

mode integer

Directingの場合は常に2です。

creationModel string

simple / scriptlist。Travelが呼び出せる制御エンドポイントを決定します。

prompt string

simpleモードで作成時に使用されたPrompt。scriptlistの場合はnullに固定されます。

eventStyle string

作成時のイベントスタイル：normal / dramatic / regular。

perspective null

Directingモデルでは通常nullです。

uploadMode null

Directing Worldでは通常nullです。

resolution string

480p / 720p.

layout string

simpleモードのカメラムーブメントスタイル。未指定の場合やscriptlistの場合は通常nullです。

narrative string

simpleモードのナラティブスタイル。未指定の場合やscriptlistの場合は通常nullです。

refWorldId string

派生作成に使用される暗号化参照World ID。

firstFrameImage object

作成時の最初のフレーム画像。レスポンスではbase64は返されません。

inputImages array

simpleモードで作成時に永続化された参照画像。scriptlistはこのフィールドを受け付けないため、通常はnullとなります。

scriptList object

scriptlist 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 null

Directingモデルでは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を実行できます。