HappyOyster-Acting-Query World Detail API Reference

​

Scope

• Authentication: Only the primary API Key is supported; temporary API Keys cannot be used (error code 403003).
  • Get the primary API Key: Get and configure an API Key.
• 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

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

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "name": "Late-Night Video Call",
        "status": "ready",
        "mode": 3,
        "creationModel": "simple",
        "prompt": "During a late-night video call, a quiet girl smiles back at the camera",
        "eventStyle": "first_frame",
        "perspective": null,
        "uploadMode": "first_frame",
        "resolution": "480p",
        "aspectRatio": "9:16",
        "layout": null,
        "narrative": null,
        "refWorldId": null,
        "firstFrameImage": {
            "url": "https://cdn.happyoyster.com/frames/portrait-call.jpg",
            "referenceType": "default"
        },
        "inputImages": null,
        "sceneImage": null,
        "roleImage": null,
        "scenePrompt": null,
        "rolePrompt": null,
        "scriptList": null,
        "previewUrl": null,
        "createdAt": "2026-09-09T08:00:00Z",
        "updatedAt": "2026-09-09T08:05:00Z"
    }
}

​

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.
• eventStyle usually has the same value as uploadMode; clients should treat uploadMode as the authoritative field for the Acting creation mode.
• The player can pre-read aspectRatio, but when actually entering the room it should still set the orientation from the Enter Travel response value.
• 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

​

Next steps

• Query World List: paginate through all Acting Worlds.
• Delete World: delete a World you no longer use.
• When the World is ready, you can Get Travel Credential.