Alibaba Cloud Model Studio:HappyOyster-Adventure-WorldビルドステータスクエリAPIリファレンス

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

スコープ

Adventure Worldのビルド進捗状況をクエリします。呼び出し前に以下を確認してください:

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

HTTP リクエスト

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/build-status?encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "generating",
        "firstFrame": null
    }
}

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "ready",
        "firstFrame": "https://cdn.happyoyster.com/frames/world_xyz789.jpg",
        "name": "Cyberpunk Detective World",
        "mode": 1
    }
}

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

• statusがreadyまたはfailedになるまで、3〜5秒ごとにポーリングしてください。
• ready状態のWorldのみが、Travelクレデンシャルとの交換およびルームへの入室を行えます。
• 非同期保存後にURL画像の検証に失敗した場合、Worldはgeneratingからfailedに移行することがあります。
• このエンドポイントはaspectRatioを返しません。perspectiveやuploadModeなどの作成メタデータが必要な場合は、World詳細のクエリを呼び出してください。

エラーコード

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

次のステップ

Worldがreadyになった後：

• Get Travel Credential：単一使用のticketと交換します。
• World 詳細のクエリ：完全な作成メタデータをクエリします。