Conversations

Delete item

Delete a message item from a conversation.

DELETE

/conversations/{conversation_id}/items/{item_id}

Python

import os
from openai import OpenAI

client = OpenAI(
  api_key=os.getenv("DASHSCOPE_API_KEY"),
  base_url="https://dashscope-intl.aliyuncs.com/api/v2/apps/protocols/compatible-mode/v1",
)

result = client.conversations.items.delete(
  "msg_xxx",
  conversation_id="conv_xxx"
)
print(result)

{
  "deleted": true,
  "id": "msg_xxx",
  "object": "conversation.item.deleted"
}

Authorizations

string

header

required

Qwen Cloud API Key. Create one in the console.

Path Parameters

string

required

The conversation ID.

Example:conv_xxx

string

required

The message item ID.

Example:msg_xxx

Response

200-application/json

boolean

Whether the deletion succeeded.

string

The deleted message item's ID.

Example:msg_xxx

enum<string>

Always conversation.item.deleted.

Available options:conversation.item.deleted

Python

import os
from openai import OpenAI

client = OpenAI(
  api_key=os.getenv("DASHSCOPE_API_KEY"),
  base_url="https://dashscope-intl.aliyuncs.com/api/v2/apps/protocols/compatible-mode/v1",
)

result = client.conversations.items.delete(
  "msg_xxx",
  conversation_id="conv_xxx"
)
print(result)

{
  "deleted": true,
  "id": "msg_xxx",
  "object": "conversation.item.deleted"
}