Skip to main content
QwenCloud home page
Docs
Adventure

HappyOyster-Adventure-Query World Build Status API Reference

Query the build progress of an Adventure World. The API returns the encrypted World ID, build status, and first-frame URL; the client polls until the World enters ready.

GET
/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/build-status
cURL - Query World build status
curl --location 'https://dashscope-intl.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
  }
}

Scope

Query the build progress of an Adventure World. Before calling, confirm the following:
  • The primary API Key is not required; either the primary or a temporary API Key can call it.
  • Query with the encryptedWorldId returned by Create World. You can start querying from the generating state.
  • Either your server or your client can call it.
If the model call fails and returns an error, see HappyOyster Error Codes.

Authorizations

​
string
header
required

QwenCloud API Key. Only the primary API Key (sk- prefix) is supported. See Get an API Key.

Header Parameters

​
string
required

API Key authentication. The primary API Key is not required; either the primary or a temporary API Key can call it. Primary API Key: starts with sk-, e.g. sk-xxx. Temporary API Key: starts with st-, e.g. st-xxx.

Query Parameters

​
string
required

The encrypted World ID returned by Create World. It is encrypted by the server; you do not need to decrypt it.

Response

200-application/json
​
integer

Return code. 0 means success; non-zero is an error code.

​
string

Error message. null on success.

​
object

Response data. null on failure.

HappyOyster-Adventure-Query World Build Status API Reference - QwenCloud