Skip to main content

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

現在のプライマリアカウント配下のAdventure Worldをページネーションで取得します。このエンドポイントはモデルごとに自動的に分離されており、DirectingやActingのWorldが返されることはありません。

スコープ

現在のプライマリアカウント配下のAdventure Worldをページネーションで取得します。呼び出し前に以下を確認してください:
  • 認証：プライマリ API Key のみがサポートされています。一時的な API Key は使用できません（エラーコード 403003）。
  • Caller：サーバーから呼び出されます。

HTTP リクエスト

  • Singapore
  • 中国（北京）
  • 米国（バージニア）
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds{WorkspaceId} を実際の ワークスペースID に置き換えます。

リクエストパラメーター

  • Worldリストのクエリ
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds?page=1&pageSize=20&status=ready' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
Authorization string （必須）API Key 認証。プライマリ API Key のみがサポートされており、sk- で始まります（例：sk-xxx）。通常、環境変数 $DASHSCOPE_API_KEY として設定されます。一時的な API Key（st- で始まる）を使用すると 403003 が返されます。
クエリパラメータ
page integer （任意）ページ番号です。デフォルトは1です。page <= 0の場合は1として扱われます。
pageSize integer （任意）ページあたりの項目数で、デフォルトは20です。pageSize <= 0の場合は20として扱われ、100を超える場合は100に制限されます。
status string （任意）ビルドステータスでフィルタリングします。不明な値はフィルタとして適用されません。許可される値：
  • generating: 構築中
  • ready: 準備完了
  • failed: 構築失敗
mode integer (任意)これを渡す必要はありません。リストはすでにAdventureモデルにフィルタリングされており、items[].modeは常に1です。それでも渡し、値が1でない場合、400000が返されます。

レスポンスパラメーター

  • クエリ成功
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedWorldId": "enc_a1b2****",
                "name": "Cyberpunk Detective World",
                "status": "ready",
                "mode": 1,
                "previewUrl": null,
                "createdAt": "2026-06-03T10:00:00Z",
                "perspective": "first_person",
                "creationModel": "simple",
                "uploadMode": "first_frame"
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 1,
            "hasMore": false
        }
    }
}
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。
message stringエラーメッセージ。成功時は null です。
data objectレスポンスデータ。失敗時は null です。

プロパティ

items array現在のページのWorld一覧。結果がない場合は空の配列となります。各項目にはencryptedWorldId、name、status（generating / ready / failed）、mode（常に1）、previewUrl（通常null）、createdAt、perspective（first_person / third_person）、creationModel（常にsimple）、およびuploadMode（first_frameに固定）が含まれます。pagination objectページネーション情報です。page、pageSize、total、および hasMore（page × pageSize < total の場合は true）が含まれます。

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

  • リスト項目は軽量スナップショットであり、画像、プロンプト、refWorldId、その他の完全な作成パラメータは返されません。完全な設定が必要な場合は、World詳細のクエリを呼び出してください。
  • 不明な status はエラーを引き起こさず、ステータスフィルタなしとして扱われます。
  • ページネーションの際は、レスポンスのpagination.pageSizeおよびhasMoreを使用してください。リクエストした値がそのまま採用されるとは限りません。
  • 空の結果はエラーではありません。items=[]と対応するページネーション情報が返されます。

エラーコード

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

次のステップ