HappyOyster-Directing-Worldビルドステータス照会APIリファレンス - Alibaba Cloud Model Studio

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

スコープ

Directing Worldのビルド進捗を照会します。呼び出す前に、以下を確認してください：

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

HTTP リクエスト

Singapore

GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/build-status

{WorkspaceId} を実際のワークスペースID に置き換えます。

米国（バージニア）

GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/build-status

{WorkspaceId} を実際のワークスペースID に置き換えます。

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

レスポンスパラメーター

ビルド中

{
    "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": "Midnight Visitor",
        "mode": 2
    }
}

code integer

リターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。

message string

エラーメッセージ。成功時は null です。

data object

レスポンスデータ。失敗時は null です。

プロパティ

encryptedWorldId string

暗号化されたWorld ID。

status string

ビルドステータス：generating / ready / failed。

firstFrame string

Worldの初回フレームURL。未生成またはビルド失敗時はnullとなります。

name string

World名。status=readyの場合にのみ返されます。

mode integer

Directingの場合は常に2です。status=readyの場合にのみ返されます。

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

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

エラーコード

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

次のステップ

Worldがreadyになった後：

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