Skip to main content
QwenCloud home page
Docs
Directing

HappyOyster-Directing-Delete World API Reference

Delete a Directing 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-directing/openapi/v1/worlds/delete
cURL - Delete World
curl --location 'https://dashscope-intl.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/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

  • Only the primary API Key is supported; temporary API Keys cannot be used (error code 403003).
  • When the World no longer exists under the same account, it returns code=0 and deleted=false, not 403001.
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 Directing encrypted World ID to delete.

Response

200-application/json
​
integer

Return code. 0 means success.

​
string

Error message. null on success.

​
object

Response data.