Skip to main content
QwenCloud home page
Docs
Adventure

HappyOyster-Adventure-Query World Detail API Reference

Query the full metadata and echoable creation parameters of a single Adventure World. For build-progress polling, use the Query World Build Status endpoint.

GET
/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/detail
cURL - Query World detail
curl --location 'https://dashscope-intl.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/detail?encryptedWorldId={encryptedWorldId}' \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"
{
  "code": 0,
  "message": null,
  "data": {
    "encryptedWorldId": "enc_a1b2****",
    "name": "Rainy Night Adventure in Jiangnan",
    "status": "ready",
    "mode": 1,
    "creationModel": "simple",
    "prompt": "A Jiangnan water town at dusk, with stone bridges and awning boats",
    "eventStyle": "normal",
    "perspective": "third_person",
    "uploadMode": "first_frame",
    "resolution": null,
    "aspectRatio": null,
    "layout": null,
    "narrative": null,
    "refWorldId": null,
    "firstFrameImage": {
      "url": "https://cdn.happyoyster.com/frames/jiangnan.jpg",
      "referenceType": "default"
    },
    "inputImages": null,
    "sceneImage": null,
    "roleImage": null,
    "scenePrompt": null,
    "rolePrompt": null,
    "scriptList": null,
    "previewUrl": null,
    "createdAt": "2026-06-03T10:00:00Z",
    "updatedAt": "2026-06-03T10:05:00Z"
  }
}

Scope

Query the full metadata and echoable creation parameters of a single Adventure World. Before calling, confirm the following:
  • Only the primary API Key is supported; temporary API Keys cannot be used (error code 403003).
  • Query with the encryptedWorldId returned by Create World. For build-progress polling, use Query World Build Status.
  • Called by your server.
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. Only the primary API Key is supported; it starts with sk-, e.g. sk-xxx. It is typically configured as the environment variable $DASHSCOPE_API_KEY. A temporary API Key (starting with st-) returns 403003.

Query Parameters

​
string
required

An Adventure encrypted World ID under the current primary account. Returned by Create World.

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.