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).- Get the primary API Key: Get and configure an API Key.
-
Prerequisites: Query with the
encryptedWorldIdreturned by Create World. For build-progress polling, use Query World Build Status. - Caller: Called by your server.
HTTP request
- Singapore
- China (Beijing)
- US (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/detailReplace {WorkspaceId} with your actual Workspace ID.Request parameters |
|
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 |
|
code integerReturn code. 0 means success; non-zero is an error code. | |
message stringError message. null on success. | |
data objectResponse data. null on failure.
Properties encryptedWorldId stringEncrypted World ID.name stringWorld name.status stringBuild status: generating / ready / failed.mode integerAlways 1 for Adventure.creationModel stringAlways simple for Adventure.prompt stringThe top-level prompt submitted at creation.eventStyle nullAdventure does not use this creation parameter; typically null. This field only takes effect for Directing creationModel=simple.perspective stringPerspective: first_person / third_person.uploadMode stringFixed to first_frame.resolution nullAdventure does not use this field; usually null.aspectRatio nullAdventure does not use this field; fixed to null.layout nullAdventure does not use this field; usually null.narrative nullAdventure does not use this field; usually null.refWorldId stringThe encrypted reference World ID used for a derived creation; null if none.firstFrameImage objectThe required first-frame image at creation; returned in URL form only. Contains url and referenceType.inputImages nullAdventure does not currently use this field.scriptList nullAdventure does not support ScriptList; fixed to null.previewUrl nullCurrently fixed to null.createdAt stringCreation time, in ISO 8601 format.updatedAt stringLast update time, in ISO 8601 format. |
Prerequisite states and call notes
- This endpoint can query a
generating,ready, orfailedWorld; some build artifacts may benullbefore 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
- Query World List: paginate through all Adventure Worlds.
- Delete World: delete a World you no longer use.
- When the World is
ready, you can Get Travel Credential.