Conversations

Update conversation

Update a conversation's metadata. This completely replaces existing metadata.

POST

/conversations/{conversation_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",
)

updated = client.conversations.update(
  "conv_xxx",
  metadata={"topic": "update"}
)
print(updated)

{
  "created_at": 1771318152759,
  "id": "conv_xxx",
  "metadata": {
    "topic": "update"
  },
  "object": "conversation"
}

Authorizations

string

header

required

Qwen Cloud API Key. Create one in the console.

Path Parameters

string

required

The conversation ID.

Example:conv_xxx

Body

application/json

object

required

Conversation metadata. Completely overwrites existing metadata. Up to 16 key-value pairs (keys: max 64 chars, values: max 512 chars).

Response

200-application/json

integer

Unix timestamp (milliseconds) when the conversation was created.

Example:1771316949128

string

The conversation ID.

Example:conv_xxx

object

Metadata key-value pairs. Up to 16 pairs (keys: max 64 chars, values: max 512 chars).

enum<string>

Always conversation.

Available options:conversation

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",
)

updated = client.conversations.update(
  "conv_xxx",
  metadata={"topic": "update"}
)
print(updated)

{
  "created_at": 1771318152759,
  "id": "conv_xxx",
  "metadata": {
    "topic": "update"
  },
  "object": "conversation"
}