查詢單個 Acting World 的完整中繼資料和可回顯建立參數。構建進度輪詢請使用查詢 World 構建狀態介面。
適用範圍
查詢單個 Acting World 的完整中繼資料和可回顯建立參數。呼叫前請確認以下事項:
-
驗證要求:僅支援 主 API Key 呼叫,臨時 API Key 無法使用(錯誤碼
403003)。- 取得主 API Key:取得與設定 API Key。
-
前置條件:使用建立 World介面返回的
encryptedWorldId查詢。構建進度輪詢應使用查詢 World 構建狀態。 -
呼叫方:您的伺服器端呼叫。
HTTP 呼叫
新加坡
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/detail
呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。
美国(維吉尼亞)
GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/detail
呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。
請求參數 | 查詢 World 詳情 |
Authorization API Key 驗證。僅支援主 API Key,以 | |
Query 參數 | |
encryptedWorldId 目前主帳號名下的 Acting 加密 World ID。由建立 World介面返回。 |
回應參數 | |
code 返回碼。 | |
message 錯誤訊息。成功時為 | |
data 回應資料。失敗時為 |
前置狀態與呼叫注意事項
- 本介面可查詢
generating、ready或failedWorld;部分構建產物在未就緒時可能為null。 - 詳情介面不回顯
async,因為它是呼叫行為開關,不是 World 屬性。 - 圖片只返回 URL 和
referenceType,不會回傳建立請求中的 base64 內容。 eventStyle通常與uploadMode同值;用戶端應以uploadMode作為 Acting 建立模式的權威欄位。- 播放器可預先讀取
aspectRatio,但實際進房時仍應以進入房間回應值設定方向。 - 查詢其它模型、其它主帳號或已刪除的 World 均返回
403001,不會洩漏資源是否存在。
錯誤碼
如果模型呼叫失敗並返回錯誤訊息,請參閱 HappyOyster 錯誤碼進行解決。
下一步
- 查詢 World 列表:分頁查詢所有 Acting World。
- 刪除 World:刪除不再使用的 World。
- World 為
ready時可取得體驗憑證。