Skip to main content
QwenCloud home page
Docs
Acting (Invitational Preview)

HappyOyster-Acting-Delete World API Reference

Delete an Acting World under the current primary account. When the World no longer exists under the same account, it returns deleted=false idempotently.

POST
/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/delete
cURL - Delete World
# Singapore (ap-southeast-1). For another region, replace ap-southeast-1 in the URL.
# API keys are region-specific. See https://docs.qwencloud.com/developer-guides/getting-started/regions
curl --location 'https://ap-southeast-1.maas.qwencloudapi.com/api/v2/apps/happyoyster-1.0-acting/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
  }
}

Scope

Delete an Acting World under the current primary account. Before calling, confirm the following:
  • Authentication: Only the primary API Key is supported; temporary API Keys cannot be used (error code 403003).
  • Prerequisites: Delete with the encryptedWorldId returned by Create World.
  • Caller: Called by your server. This endpoint does not accept the request body field userAgent.
If the model call fails and returns an error, see HappyOyster Error Codes to resolve it.

Authorizations

​
string
header
required

QwenCloud API Key. Only the primary API Key (sk- prefix) is supported. See Get an API Key.

Header Parameters

​
string
default"application/json"
required

Request content type. This parameter must be set to application/json.

​
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.

Body

application/json
​
string
required

The Acting encrypted World ID to delete. Returned by Create World.

Response

200-application/json
​
integer

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

​
string | null

Error message. null on success.

​
object

Response data. null on failure.