Skip to main content

HappyOyster-Adventure-World詳細クエリAPIリファレンス

単一のAdventure Worldの完全なメタデータおよび反映可能な作成パラメータをクエリします。ビルド進捗のポーリングには、Worldビルドステータスクエリエンドポイントを使用してください。

スコープ

単一のAdventure Worldの完全なメタデータおよび反映可能な作成パラメータをクエリします。呼び出し前に以下を確認してください:
  • 認証：プライマリ API Key のみがサポートされています。一時的な API Key は使用できません（エラーコード 403003）。
  • 前提条件：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-adventure/openapi/v1/worlds/detail{WorkspaceId} を実際の ワークスペースID に置き換えます。

リクエストパラメーター

  • World詳細のクエリ
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/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 （必須）現在のプライマリアカウント配下のAdventure暗号化World IDです。Worldを作成によって返されます。

レスポンスパラメーター

  • クエリ成功
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "name": "Rainy Night Adventure in Jiangnan",
        "status": "ready",
        "mode": 1,
        "creationModel": "simple",
        "prompt": "A Jiangnan water town at dusk, with stone bridges and awning boats",
        "eventStyle": null,
        "perspective": "third_person",
        "uploadMode": "first_frame",
        "resolution": null,
        "aspectRatio": null,
        "layout": null,
        "narrative": null,
        "refWorldId": null,
        "firstFrameImage": {
            "url": "https://cdn.happyoyster.com/frames/jiangnan.jpg",
            "referenceType": "default"
        },
        "inputImages": null,
        "sceneImage": null,
        "roleImage": null,
        "scenePrompt": null,
        "rolePrompt": null,
        "scriptList": null,
        "previewUrl": 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 stringWorld名。status stringビルドステータス：generating / ready / failed。mode integerAdventure の場合は常に 1 です。creationModel stringAdventure の場合は常に simple です。prompt string作成時に送信された最上位のプロンプト。eventStyle nullAdventureではこの作成パラメータを使用しません。通常はnullです。このフィールドはDirectingのcreationModel=simpleの場合にのみ有効です。perspective string視点: first_person / third_person。uploadMode stringfirst_frameに固定されています。resolution nullAdventureではこのフィールドを使用しません。通常はnullです。aspectRatio nullAdventureではこのフィールドを使用しません。nullに固定されています。layout nullAdventureではこのフィールドを使用しません。通常はnullです。narrative nullAdventureではこのフィールドを使用しません。通常はnullです。refWorldId string派生作成に使用される暗号化された参照World ID。ない場合はnullとなります（none）。firstFrameImage object作成時に必須となる初回フレーム画像。URL形式でのみ返されます。urlとreferenceTypeを含みます。inputImages nullAdventureでは現在このフィールドを使用しません。scriptList nullAdventureはScriptListをサポートしていません。nullに固定されています。previewUrl null現在はnullに固定されています。createdAt string作成日時。ISO 8601形式です。updatedAt string最終更新時刻です。ISO 8601形式です。

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

  • このエンドポイントはgenerating、ready、またはfailed状態のWorldをクエリできます。準備が整う前のビルド成果物はnullとなる場合があります。
  • 詳細エンドポイントはasyncをエコーしません。これはWorldの属性ではなく、呼び出し動作の切り替えであるためです。
  • 画像はURLおよびreferenceTypeとしてのみ返されます。作成リクエスト内のbase64コンテンツは返されません。
  • 別のモデル、別のプライマリアカウント、または削除済みのWorldをクエリした場合、いずれも403001が返され、リソースが存在するかどうかは開示されません。

エラーコード

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

次のステップ