Conversations

Retrieve item

Retrieve a message item by its ID.

GET

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

item = client.conversations.items.retrieve(
  "msg_xxx",
  conversation_id="conv_xxx"
)
print(item)

{
  "content": [
    {
      "text": "Alice's major is teacher education",
      "type": "input_text"
    }
  ],
  "id": "msg_xxx",
  "role": "user",
  "status": "completed",
  "type": "message"
}

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

string

The message item ID.

Example:msg_xxx

string

Message content. A plain text string or a structured content list (such as ResponseInputText object array).

enum<string>

Message role: user, assistant, system, or developer.

Available options:user,assistant,system,developer

enum<string>

Processing status: in_progress, completed, or incomplete.

Available options:in_progress,completed,incomplete

enum<string>

Always message.

Available options:message

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

item = client.conversations.items.retrieve(
  "msg_xxx",
  conversation_id="conv_xxx"
)
print(item)

{
  "content": [
    {
      "text": "Alice's major is teacher education",
      "type": "input_text"
    }
  ],
  "id": "msg_xxx",
  "role": "user",
  "status": "completed",
  "type": "message"
}