Skip to main content
QwenCloud home page
Docs
Acting (Invitational Preview)

HappyOyster-Acting-Query World Build Status API Reference

Query the build progress of an Acting 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-acting/openapi/v1/worlds/build-status
cURL - Query World build status
# Singapore (ap-southeast-1). For another region, replace ap-southeast-1 in the URL.
# API keys are region-specific. See https://docs.qwencloud.com/developer-guides/getting-started/regions
curl --location 'https://ap-southeast-1.maas.qwencloudapi.com/api/v2/apps/happyoyster-1.0-acting/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 Acting World. Before calling, confirm the following:
  • Authentication: The primary API Key is not required; either the primary or a temporary API Key can call this endpoint.
  • Prerequisites: Query with the encryptedWorldId returned by Create World. You can start querying from the generating state; the World does not need to be fully built.
  • Caller: Either your server or your client can call it.
If the model call fails and returns an error, see HappyOyster Error Codes to resolve it.

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 Acting encrypted World ID returned by Create World.

Response

200-application/json
​
integer

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

​
string | null

Error message. null on success.

​
object

Response data. null on failure.