HappyOyster-Adventure-Delete World 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: Delete with the encryptedWorldId returned by Create World.
• Caller: Called by your server. This endpoint does not accept the request body field userAgent.

​

HTTP request

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/delete' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedWorldId": "{encryptedWorldId}"
}'

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "deleted": true
    }
}

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "deleted": false
    }
}

​

Prerequisite states and call notes

• When the World no longer exists under the same account, it returns code=0 and deleted=false, not 403001.
• When the ID is parseable but crosses accounts, does not match the workspace, or the resource is not an Adventure World, 403001 is returned.
• After deletion, subsequent detail, build-status, or credential-exchange calls are handled as a non-existent resource.

​

Error codes

​

Next steps

• Query World List: view the remaining Adventure Worlds.
• Create World: create a new Adventure World.