Skip to main content

HappyOyster-Acting-Query World Build Status APIリファレンス

Acting Worldのビルド進捗をクエリします。APIは暗号化されたWorld ID、ビルドステータス、および初回フレームURLを返します。クライアントはWorldがready状態になるまでポーリングを行います。

スコープ

Acting Worldのビルド進捗をクエリします。呼び出し前に以下を確認してください：
  • 認証：primary API Keyは必須ではありません。プライマリAPI Keyまたは一時API Keyのいずれかでこのエンドポイントを呼び出せます。取得方法については、認証クレデンシャルの取得を参照してください。
  • 前提条件：Create World によって返された encryptedWorldId を使用してクエリします。generating ステータスからクエリを開始できます。World が完全に構築されている必要はありません。
  • 呼び出し元：サーバーまたはクライアントのいずれからも呼び出すことができます。

HTTP リクエスト

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

リクエストパラメーター

  • Worldビルドステータスのクエリ
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/build-status?encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
Authorization string （必須）API キー認証です。プライマリ API キーは必須ではなく、プライマリまたは一時 API キーのいずれかで呼び出せます。
  • Primary API Key：sk-で始まります（例：sk-xxx）。通常、環境変数$DASHSCOPE_API_KEYとして設定されます。
  • 一時 API キー：st- で始まり、例は st-xxx です。
クエリパラメータ
encryptedWorldId string （必須）Create Worldによって返されるActingの暗号化World ID。

レスポンスパラメーター

  • ビルド中
  • ビルド完了
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "generating",
        "firstFrame": null
    }
}
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。
message stringエラーメッセージ。成功時は null です。
data objectレスポンスデータ。失敗時は null です。

プロパティ

encryptedWorldId string暗号化されたWorld ID。status stringビルドステータス：
  • generating: 構築中
  • ready：準備完了。Travelクレデンシャルと交換してルームに入ることができます
  • failed: 構築失敗
firstFrame stringWorldの初回フレームURL。未生成またはビルド失敗時はnullとなります。name stringWorld名。status=readyの場合にのみ返されます。mode integerActingでは常に3です。status=readyの場合にのみ返されます。

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

  • statusがreadyまたはfailedになるまで、3〜5秒ごとにポーリングしてください。
  • ready状態のWorldのみが、Travelクレデンシャルとの交換およびルームへの入室を行えます。
  • 非同期保存後にURL画像の検証に失敗した場合、Worldはgeneratingからfailedに移行することがあります。
  • このエンドポイントは aspectRatio を返しません。プレーヤーの向きは Enter the room レスポンスの aspectRatio によって決定されます。

エラーコード

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

次のステップ

Worldがreadyになった後：