Skip to main content

HappyOyster-Directing-查詢 World 列表 API 參考

分頁查詢當前主帳號名下的 Directing World。接口自動按模型隔離，不會返回 Acting 或 Adventure World。

適用範圍

分頁查詢當前主帳號名下的 Directing World。調用前請確認以下事項：
  • 驗證要求：僅支援 主 API Key 呼叫，臨時 API Key 無法使用（錯誤碼 403003）。
  • 呼叫方：您的伺服器端呼叫。

HTTP 呼叫

  • 新加坡
  • 美国（維吉尼亞）
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。

請求參數

  • 查詢 World 列表
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/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。
Query 參數
page integer （可選）頁碼，預設 1。page <= 0 時按 1 處理。
pageSize integer （可選）每頁筆數，預設 20。pageSize <= 0 時按 20，大於 100 時按 100 處理。
status string （可選）按構建狀態篩選。未知值不篩選。可選值：
  • generating：建立中
  • ready：就緒
  • failed：建立失敗
mode integer （可選）無需傳入。列表已按 Directing 模型過濾，items[].mode 恆為 2。若仍傳入且非 2 返回 400000。

回應參數

  • 查詢成功
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedWorldId": "enc_a1b2****",
                "name": "午夜访客",
                "status": "ready",
                "mode": 2,
                "perspective": null,
                "creationModel": "scriptlist",
                "uploadMode": null,
                "createdAt": "2026-06-03T10:00:00Z"
            },
            {
                "encryptedWorldId": "enc_g7h8****",
                "name": "霓虹小巷",
                "status": "ready",
                "mode": 2,
                "perspective": null,
                "creationModel": "simple",
                "uploadMode": null,
                "createdAt": "2026-06-03T12:00:00Z"
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 2,
            "hasMore": false
        }
    }
}
code integer返回碼。0 表示成功，非 0 為錯誤碼。
message string錯誤訊息。成功時為 null。
data object回應資料。失敗時為 null。

屬性

items array當前頁 World 列表；無結果時為空陣列。每項含 encryptedWorldId、name、status（generating / ready / failed）、mode（恆為 2）、perspective（通常為 null）、creationModel（simple / scriptlist）、uploadMode（通常為 null）、createdAt。pagination object分頁資訊。包含 page、pageSize、total、hasMore（當 page × pageSize < total 時為 true）。

前置狀態與呼叫注意事項

  • 列表項是輕量快照，不返回圖片、scriptList 或 aspectRatio。需要完整元數據時，按 encryptedWorldId 調用查詢 World 詳情。
  • 未知 status 不會報錯，而是按不篩選狀態處理。
  • 翻頁時應使用回應中的 pagination.pageSize 和 hasMore，不要假設請求值一定原樣採用。

錯誤碼

如果模型呼叫失敗並返回錯誤訊息，請參閱 HappyOyster 錯誤碼進行解決。

下一步