All Products
Search

This Product

    Alibaba Cloud Model Studio:HappyOyster-Acting-Delete World API Reference

    Document Center

    Alibaba Cloud Model Studio:HappyOyster-Acting-Delete World API Reference

    Last Updated:Sep 20, 2026

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

    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.

    HTTP request

    Singapore

    POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/delete

    Replace {WorkspaceId} with your actual Workspace ID.

    US (Virginia)

    POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/delete

    Replace {WorkspaceId} with your actual Workspace ID.

    Request parameters

    Delete World

    curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.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}"
}'

    Content-Typestring(Required)

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

    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.

    Request Body

    encryptedWorldId string (Required)

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

    Response parameters

    Deleted successfully

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

    World no longer exists

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

    code integer

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

    message string

    Error message. null on success.

    data object

    Response data. null on failure.

    Properties

    encryptedWorldId string

    The encrypted World ID from the request.

    deleted boolean

    true means it was deleted; false means no World was deleted this time.

    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 Acting World, 403001 is returned.
    • After deletion, subsequent detail, build-status, or credential-exchange calls are handled as a non-existent resource.
    • An issued but unused ticket should not be treated as a long-term valid reference; the World's availability is still re-validated when entering the room.

    Error codes

    If the model call fails and returns an error, see HappyOyster Error Codes to resolve it.

    Next steps