All Products
Search

This Product

    Alibaba Cloud Model Studio:HappyOyster-Adventure-Query World Detail API Reference

    Document Center

    Alibaba Cloud Model Studio:HappyOyster-Adventure-Query World Detail API Reference

    Last Updated:Sep 20, 2026

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

    Scope

    Query the full metadata and echoable creation parameters of a single Adventure World. Before calling, confirm the following:

    • Authentication: Only the primary API Key is supported; temporary API Keys cannot be used (error code 403003).

    • Prerequisites: Query with the encryptedWorldId returned by Create World. For build-progress polling, use Query World Build Status.

    • Caller: Called by your server.

    HTTP request

    Singapore

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

    Replace {WorkspaceId} with your actual Workspace ID.

    China (Beijing)

    GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/detail

    Replace {WorkspaceId} with your actual Workspace ID.

    US (Virginia)

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

    Replace {WorkspaceId} with your actual Workspace ID.

    Request parameters

    Query World detail

    curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/detail?encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"

    Authorization 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

    encryptedWorldId string (Required)

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

    Response parameters

    Query succeeded

    {
    "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": null,
        "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"
    }
}

    code integer

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

    message string

    Error message. null on success.

    data object

    Response data. null on failure.

    Properties

    encryptedWorldId string

    Encrypted World ID.

    name string

    World name.

    status string

    Build status: generating / ready / failed.

    mode integer

    Always 1 for Adventure.

    creationModel string

    Always simple for Adventure.

    prompt string

    The top-level prompt submitted at creation.

    eventStyle null

    Adventure does not use this creation parameter; typically null. This field only takes effect for Directing creationModel=simple.

    perspective string

    Perspective: first_person / third_person.

    uploadMode string

    Fixed to first_frame.

    resolution null

    Adventure does not use this field; usually null.

    aspectRatio null

    Adventure does not use this field; fixed to null.

    layout null

    Adventure does not use this field; usually null.

    narrative null

    Adventure does not use this field; usually null.

    refWorldId string

    The encrypted reference World ID used for a derived creation; null if none.

    firstFrameImage object

    The required first-frame image at creation; returned in URL form only. Contains url and referenceType.

    inputImages null

    Adventure does not currently use this field.

    scriptList null

    Adventure does not support ScriptList; fixed to null.

    previewUrl null

    Currently fixed to null.

    createdAt string

    Creation time, in ISO 8601 format.

    updatedAt string

    Last update time, in ISO 8601 format.

    Prerequisite states and call notes

    • This endpoint can query a generating, ready, or failed World; some build artifacts may be null before they are ready.
    • The detail endpoint does not echo async, because it is a call-behavior switch, not a World attribute.
    • Images are returned only as URL and referenceType; the base64 content in the creation request is not returned.
    • Querying a World from another model, another primary account, or one that has been deleted all return 403001, without revealing whether the resource exists.

    Error codes

    If the model call fails and returns an error, see HappyOyster Error Codes to resolve it.

    Next steps