Skip to main content
QwenCloud home page
Docs
Adventure

HappyOyster-Adventure-Query World List API Reference

Paginate through the Adventure Worlds under the current primary account. The endpoint is automatically isolated by model and never returns Directing or Acting Worlds.

GET
/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds
cURL - Query World list
curl --location 'https://dashscope-intl.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds?page=1&pageSize=20&status=ready' \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"
{
  "code": 0,
  "message": null,
  "data": {
    "items": [
      {
        "encryptedWorldId": "enc_a1b2****",
        "name": "Cyberpunk Detective World",
        "status": "ready",
        "mode": 1,
        "previewUrl": null,
        "createdAt": "2026-06-03T10:00:00Z",
        "perspective": "first_person",
        "creationModel": "simple",
        "uploadMode": "first_frame"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 20,
      "total": 1,
      "hasMore": false
    }
  }
}

Scope

Paginate through the Adventure Worlds under the current primary account. Before calling, confirm the following:
  • Only the primary API Key is supported; temporary API Keys cannot be used (error code 403003).
  • The endpoint is automatically isolated by model and never returns Directing or Acting Worlds.
  • 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

​
integer
default1

Page number, defaults to 1. When page <= 0 it is treated as 1.

​
integer
default20

Items per page, defaults to 20. When pageSize <= 0 it is treated as 20; when greater than 100 it is capped at 100.

​
enum<string>

Filter by build status. Unknown values are not applied as a filter. Allowed values: generating (building), ready (ready), failed (build failed).

Available options:generating,ready,failed
​
integer

No need to pass this. The list is already filtered to the Adventure model, and items[].mode is always 1. If you still pass it and the value is not 1, 400000 is returned.

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.