Conversations API session management

Reference, synced 2026-06-13.

flowchart TD
  n0["Models"]
  n1["Overview"]
  n2["Products"]
  n3["Solutions"]
  n4["Pricing"]
  n5["Resources"]
  n6["Partners"]
  n7["Support"]
  n8["Language"]
  n0 --> n1
  n1 --> n2
  n2 --> n3
  n3 --> n4
  n4 --> n5
  n5 --> n6
  n6 --> n7
  n7 --> n8

Free access Accelerate Delivery with Fixed-Cost Agentic CodingWatch how it works

Models

Empowering AI innovation for both enterprises and developers with Alibaba Cloud’s best-in-class Qwen models, AI-native apps, and AI solutions.

Alibaba Cloud Model Studio \ Enterprise-grade large model service and application development platform.

Try Visual Model \ Supports image understanding, image generation, and video generation.

Models

HappyHorse-1.0-T2V \ Cinematic creative generation, ultimate dynamic details Qwen3-VL-Plus \ Native VL, spatial reasoning, 1M-context video analysis Wan2.7-VideoEdit \ Supports both localized and global editing with prompt

Qwen3.6-Plus \ Native multimodal, 1M context, agentic coding Wan2.7-Image-Pro \ Interactive editing, long-text rendering, precise prompt following Qwen-Plus \ Balanced intelligence, efficient inference, production-ready performance

Qwen-Image-2.0 \ Professional infographics, exquisite photorealism Z-Image-Turbo \ Ultra-fast image generation, high throughput, cost-optimized inference Qwen3-Coder-Next \ Multi-turn tool interactions, future-ready development support

Wan2.7-T2V \ High-fidelity T2V, 15s duration, advanced camera control Wan2.7-I2V \ Cinematic I2V with emotional depth and visceral impact Wan2.7-R2V \ Up to 5 mixed image/video inputs and audio timbre cloning

GenAI Application

Qoder \ Intelligent coding assistant, available for enterprise-dedicated deployment. Qoder CN \ AI-powered coding assistant that boosts developer productivity with intelligent code completion, AI chat, multi-file editing, and task automation.

AI Service

Model Experience \ Experience full-scale, multimodal model capabilities online. Platform for AI \ An AI-native algorithm engineering platform for end-to-end modeling, training, and inference service deployment. Fine-tune Video Generation Model \ Customize Wan’s text-to-video capabilities through model fine-tuning to meet your unique requirements.

AI Use Case

AI Savings Plan Hot \ Save up to 47% on AI costs. Limited-time offer tailored to your usage. AI Video Creation \ Elevate your professional video production with Wan 2.6.

AI Token Plan \ One plan. Multiple models. Big Savings with a Fixed Subscription. AI Image Creation \ All-in-one creative suite for copywriting, image generation, and poster design.

Overview

As a global full-stack AI leader, Alibaba Cloud aims to make computing accessible to everyone and help worldwide customers accelerate innovation.

Why Alibaba Cloud

About Alibaba Cloud \ AI Powered Cloud Technology Our Global Network \ Explore our global presence and deployment regions around the world Our Global Offices \ With offices in 4 continents, we're always close to where it matters.

Asia Accelerator \ Accelerate Success in Asia with Alibaba Cloud Go Global \ Benefits of our Global Alliance Trust Center \ Empowering enterprises with a secure, compliant, and globally trusted cloud infrastructure

Customers and Insights

Olympic Games \ Alibaba Cloud Powers Olympic Games with AI-powered cloud technology Case Studies \ Learn how customers are scaling their businesses on Alibaba Cloud Analyst Reports \ Learn what the top industry analyst firms are saying about Alibaba Cloud

What's New

Events and Webinars \ Quick access to upcoming and on-demand events Product Updates \ Stay informed of the latest innovations Press Room \ Latest news and media releases

Products

Featured ProductsAI & Machine Learning Computing Container Storage Networking & CDN Security Middleware Database Analytics ComputingMedia ServicesEnterprise Services & Cloud CommunicationDomain Names and WebsitesEnd User ComputingServerlessDeveloper ToolsMigration & O&M ManagementApsara Stack

Featured Products

Alibaba Cloud Model Studio \ Supercharge your AI journey effortlessly with industry-leading GenAI models ApsaraDB RDS \ Store and manage your business data, with automated monitoring and backups Certificate Management Service (Original SSL Certificate) \ Create a safe and secure connection between your website and users

Elastic Compute Service (ECS) \ Host websites anywhere and scale enterprise workloads Container Service for Kubernetes (ACK) \ Run and scale containerized applications on managed Kubernetes infrastructure Object Storage Service (OSS) \ Store large amounts of data in the cloud and access it anywhere, anytime

Simple Application Server (SAS) \ All-in-one services for fast deployment Elastic IP Address (EIP) \ Manage your public IPs independently to improve internet network quality Domain Names and Website \ Get the perfect domain name to suit your every need

Solutions

Solutions by Industry Technical Solutions AI WebsitesNetworking Security and ComplianceData and AnalyticsEnterprise Service and ApplicationCloud MigrationCloud NativeHybrid CloudSMB solutions

Financial Services \ Innovate faster with Alibaba Cloud Games \ Grow your game rapidly with high global availability

New Retail \ Alibaba Cloud enables digital retail transformation to fuel growth and realize an omnichannel customer experience throughout the consumer journey. Media and Entertainment \ Ready your content for today's media market with a digitalized media journey

Supply Chain \ Power your supply chain with intelligent, efficient, and reliable solutions Sports \ Digitizing the sports industry with intelligent tech

Sustainability \ Achieve a sustainable future with low-carbon and energy-efficient technologies

Pricing

Flexible options like pay-as-you-go and clear billing rules to meet diverse business needs.

Overview & Tools

Pricing Calculator \ Get an instant pricing estimate based on your usage and needs Free Trial \ Try our 80+ cloud products for free.

Pricing Options \ Get the most out of Alibaba Cloud with flexible pricing

Optimize your cost

Migrate & Save \ Superior Performance At Lower Pricing. Save up to 50%. Promotion Center \ Unlock the latest Alibaba Cloud offers & promos

Resources

Official documentation, extensive tools, training resources, and a community to grow and innovate in the cloud.

Technical Resources

Documentation \ Product guides and FAQs Architecture Center \ Design reliable, secure, and efficient cloud architecture. Intelligent Solution Explorer \ Find the right solution for you, powered by AI

Blog \ Latest cloud insights and developer trends Whitepapers \ Research that explores the how and why behind our technology

Training&Certification

Alibaba Cloud Academy \ Build cloud skills and earn certifications with expert-led training.

Developer Hub

Alibaba Cloud Project Hub \ Explore real-world projects built by developers using our platform. Our Developer MVPs \ Celebrating the developers who lead, build, and inspire our community

Partners

Partner-first strategy offering collaborative product, sales, and service models, plus high-quality partner solutions that complement Alibaba Cloud’s capabilities.

Marketplace

AI Alliance for ISVs \ Partner with us to build and grow AI solutions together ISV Benefits \ Unlock resources, market access, and go-to-market support as an ISV partner

Alibaba Cloud Marketplace \ Explore ready-to-deploy solutions from our partners and ISVs

Find a Partner

Partner Hub \ Find your ideal partner in no time

Become a Partner

Partner Network \ A partner portal for Alibaba Cloud Channel, Technology, MSP partner and other partner programs

Support

Full-lifecycle support and expert services, from cloud advisory and migration to operations.

Support & Professional Services

Professional Services \ Expert-led services to design, migrate, and optimize your cloud journey Support Plans \ Flexible support for every stage — from startup to enterprise

Partner Support Program \ Priority technical support for partners, with dedicated managers and faster issue resolution

Contact us

Connect With Us \

Talk to a sales expert and get a custom quote for your business

Language

English
简体中文
繁體中文
日本語
Bahasa Indonesia

Locale

Visit aliyun.com

Documentation

Alibaba Cloud Model Studio

User Guide (Models) User Guide (Application) API Reference (Models) API Reference (Application)

Search for Help Content

Getting Started

The Beginner's Guide

Well-Architected Framework

AI & Machine Learning

Platform For AI

Alibaba Cloud Model Studio

DashVector

Artificial Intelligence Recommendation

OpenSearch

Image Search

Machine Translation

Intelligent Speech Interaction

Optimization Solver

Intelligent Computing LINGJUN

Computing

Elastic Compute Service

Elastic GPU Service

Elastic Container Instance

Dedicated Host

Compute Nest

Simple Application Server

Cloud Box

Auto Scaling

Elastic High Performance Computing

Batch Compute (Deprecated)

Function Compute

Serverless App Engine

ENS

Elastic Desktop Service

App Streaming

WUYING Terminal

Cloud Phone

Edge Network Acceleration

Alibaba Cloud Linux

AgentBay

Container

Container Service for Kubernetes

Container Compute Service

Container Registry

Storage

Object Storage Service

Cloud Parallel File Storage

File Storage NAS

Tablestore

Storage Capacity Unit

Simple Log Service

Cloud Backup

Intelligent Media Management

Drive and Photo Service

Data Transport

Cloud Storage Gateway

Data Online Migration

Hybrid Cloud Storage Array

Storage Services Overview

Backup and Disaster Recovery Center

Networking and CDN

Server Load Balancer

Elastic IP Address

Internet Shared Bandwidth

Data Transfer Plan

Virtual Private Cloud

NAT Gateway

PrivateLink

Alibaba Cloud DNS PrivateZone

Network Intelligence Service

Cloud Data Transfer

IPv6 Gateway

Anycast Elastic IP Address

Cloud Enterprise Network

Global Accelerator

VPN Gateway

Smart Access Gateway

Express Connect

CDN

Edge Security Acceleration

Cloud Network Well-architected Design Guidelines

Security

Anti-DDoS

Web Application Firewall

Cloud Firewall

Security Center

Bastionhost

Secure Access Service Edge

Certificate Management Service

Key Management Service

Data Security Center

Identity as a Service

Fraud Detection

AI Guardrails

Captcha

Blockchain as a Service

ID Verification

Managed Security Service

Middleware

Enterprise Distributed Application Service

Microservices Engine

Alibaba Cloud Service Mesh

SchedulerX

ApsaraMQ for RocketMQ

ApsaraMQ for Kafka

ApsaraMQ for RabbitMQ

ApsaraMQ for MQTT

Simple Message Queue (formerly MNS)

CloudFlow

EventBridge

Application Real-Time Monitoring Service

Managed Service for Prometheus

Managed Service for Grafana

Managed Service for OpenTelemetry

Performance Testing

STAROps

Databases

ApsaraDB Console

PolarDB

ApsaraDB RDS

ApsaraDB for OceanBase (Deprecated)

Tair (Redis® OSS-Compatible)

Lindorm

Time Series Database

ApsaraDB for MongoDB

ApsaraDB for HBase

ApsaraDB for Memcache

ApsaraDB for MyBase

AnalyticDB

ApsaraDB for ClickHouse

ApsaraDB for SelectDB

Data Transmission Service

Database Autonomy Service

Data Management

Database Gateway - Deprecated

ApsaraDB for Cassandra - Deprecated

Analytics Computing

MaxCompute

Hologres

Realtime Compute for Apache Flink

Elasticsearch

Vector Retrieval Service for Milvus

E-MapReduce

Data Lake Formation

DataV

Quick BI

Quick Audience

Quick Tracking

DataWorks

DataHub

Dataphin

Media Services

ApsaraVideo VOD

ApsaraVideo Live

Intelligent Media Services

ApsaraVideo Media Processing

Apsara Video SDK

Enterprise Services & Cloud Communication

Energy Expert

CloudQuotation

Salesforce on Alibaba Cloud

GoChina ICP Filing Assistant

Marketplace

Alibaba Mail

Direct Mail

Short Message Service

Voice Service

Phone Number Verification Service

Cell Phone Number Service

Chat App Message Service

Financial Intelligence Engine

Domain Names and Websites

Domain Names

ICP Filing

Alibaba Cloud DNS

End User Computing

Elastic Desktop Service

App Streaming

WUYING Terminal

Cloud Phone

AgentBay

Internet of Things

IoT Platform

Serverless

Serverless App Engine

CloudFlow

EventBridge

Simple Message Queue (formerly MNS)

Function Compute

Developer Tools

OpenAPI Explorer

Alibaba Cloud SDK

Cloud Shell

Resource Orchestration Service

Alibaba Cloud CLI

BSS OpenAPI

Terraform

Pulumi

Ticket System API

Mobile Platform as a Service

Alibaba Cloud DevOps

API Gateway

Cloud Control API

AI Coding Assistant Lingma

Cloud Skills Portal

Migration & O&M Management

CloudOps Orchestration Service

Cloud Monitor

Intelligent Advisor

Cloud Governance Center

ActionTrail

Cloud Config

Resource Access Management

Resource Management

Cloud Architect Design Tools

Migration Hub

Server Migration Center

Service Catalog

Logic Composer

Quota Center

CloudSSO

HTTPDNS

Solutions

SAP

SuperApp

OpenLake

Membership Service

Expenses and Costs

Account Center

Support

Legal

Tech Share Terms and Conditions

After Sales Support

China Gateway Program

Service Level Objectives

Management Console

Security Control

Manually managing message lists for conversations that span multiple devices or have long interruptions can lead to context loss. Alibaba Cloud Model Studio provides an OpenAI-compatible Conversations API that you can use with the Responses API to automatically inject historical context. This eliminates the need for manual message synchronization and ensures conversational continuity across different scenarios and devices.

Create conversation

Creates a new conversation. You can optionally include initial message items.

North China 2 (Beijing): POSThttps://dashscope.aliyuncs.com/compatible-mode/v1/conversations

Singapore: POSThttps://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations

Important

The legacy URL path /api/v2/apps/protocols/compatible-mode/v1/responses will soon be deprecated. Migrate to the new path /compatible-mode/v1/responses as soon as possible.

Important

The legacy Singapore domain https://dashscope-intl.aliyuncs.com will be discontinued. Migrate to https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com as soon as possible.

itemsarray (Optional) A list of up to 20 initial message items. Properties typestring (Required) The message type. Only message is supported. rolestring (Required) The role of the message. Instructions from the system and developer roles have a higher priority than instructions from the user role. The assistant role indicates messages that were generated by the model in previous interactions. Valid values are user, assistant, system, and developer. contentstring or array (Required) The message content. This parameter supports plain text strings or structured content lists, such as ResponseInputText object arrays. The list format can include various content types, such as text. Python Node.js cURL python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) conversation = client.conversations.create( metadata={"topic": "demo"}, items=[ {"type": "message", "role": "system", "content": "Alice, a gentle and resilient woman, was born in Singapore. She is 20 years old, and her hobbies are music and chess."} ] ) print(conversation) javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const conversation = await client.conversations.create({ metadata: { topic: "demo" }, items: [ { type: "message", role: "system", content: "Alice, a gentle and resilient woman, was born in Singapore. She is 20 years old, and her hobbies are music and chess." } ] }); console.log(conversation); bash curl --location 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY' \ --data '{ "metadata": { "topic": "demo" }, "items": [ { "type": "message", "role": "system", "content": "Alice, a gentle and resilient woman, was born in Singapore. She is 20 years old, and her hobbies are music and chess." } ] }'

metadataobject (Optional) The conversation metadata. Use this parameter to store additional conversation information in a structured format. Specify up to 16 key-value pairs. The key can be up to 64 characters long, and the value can be up to 512 characters long.


items`array` (Optional) A list of up to 20 initial message items. Properties type`string` (Required) The message type. Only `message` is supported. role`string` (Required) The role of the message. Instructions from the `system` and `developer` roles have a higher priority than instructions from the `user` role. The `assistant` role indicates messages that were generated by the model in previous interactions. Valid values are `user`, `assistant`, `system`, and `developer`. content`string or array` (Required) The message content. This parameter supports plain text strings or structured content lists, such as ResponseInputText object arrays. The list format can include various content types, such as text.	Python Node.js cURL `python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) conversation = client.conversations.create( metadata={"topic": "demo"}, items=[ {"type": "message", "role": "system", "content": "Alice, a gentle and resilient woman, was born in Singapore. She is 20 years old, and her hobbies are music and chess."} ] ) print(conversation)` `javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const conversation = await client.conversations.create({ metadata: { topic: "demo" }, items: [ { type: "message", role: "system", content: "Alice, a gentle and resilient woman, was born in Singapore. She is 20 years old, and her hobbies are music and chess." } ] }); console.log(conversation);` `bash curl --location 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY' \ --data '{ "metadata": { "topic": "demo" }, "items": [ { "type": "message", "role": "system", "content": "Alice, a gentle and resilient woman, was born in Singapore. She is 20 years old, and her hobbies are music and chess." } ] }'`
metadata`object` (Optional) The conversation metadata. Use this parameter to store additional conversation information in a structured format. Specify up to 16 key-value pairs. The key can be up to 64 characters long, and the value can be up to 512 characters long.

Response parameters


created_at`integer` The Unix timestamp in milliseconds that indicates when the conversation was created.	`json { "created_at": 1771316949128, "id": "conv_xxx", "metadata": { "topic": "demo" }, "object": "conversation" }`
id`string` The unique ID of the conversation.
metadata`object` The conversation metadata. This parameter stores additional information as key-value pairs. It can contain up to 16 pairs. The key can be up to 64 characters long, and the value can be up to 512 characters long.
object`string` The object type. The value is fixed as `conversation`.

Retrieve conversation

Retrieves information for a specified conversation.

North China 2 (Beijing): GEThttps://dashscope.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}

Singapore: GEThttps://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}

conversation_idstring (Required, Path) The conversation ID. Python Node.js cURL python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) conversation = client.conversations.retrieve("conv_xxx") print(conversation) javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const conversation = await client.conversations.retrieve( "conv_xxx" ); console.log(conversation); bash curl --location 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations/conv_xxx' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY'


conversation_id`string` (Required, Path) The conversation ID.	Python Node.js cURL `python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) conversation = client.conversations.retrieve("conv_xxx") print(conversation)` `javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const conversation = await client.conversations.retrieve( "conv_xxx" ); console.log(conversation);` `bash curl --location 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations/conv_xxx' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY'`

Response parameters


created_at`integer` The Unix timestamp in milliseconds that indicates when the conversation was created.	`json { "created_at": 1771316949128, "id": "conv_xxx", "metadata": { "topic": "demo" }, "object": "conversation" }`
id`string` The unique ID of the conversation.
metadata`object` The conversation metadata. This parameter stores additional information as key-value pairs. It can contain up to 16 pairs. The key can be up to 64 characters long, and the value can be up to 512 characters long.
object`string` The object type. The value is fixed as `conversation`.

Update conversation

Updates the metadata for a conversation.

North China 2 (Beijing): POSThttps://dashscope.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}

Singapore: POSThttps://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}

conversation_idstring (Required, Path) The ID of the conversation. Python Node.js cURL python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) updated = client.conversations.update( "conv_xxx", metadata={"topic": "update"} ) print(updated) javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const updated = await client.conversations.update( "conv_xxx", { metadata: { topic: "update" } } ); console.log(updated); bash curl --location 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations/conv_xxx' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY' \ --data '{ "metadata": { "topic": "update" } }'

metadataobject (Required) The conversation metadata. This parameter completely overwrites the existing metadata. Specify up to 16 key-value pairs. The key can be up to 64 characters long, and the value can be up to 512 characters long.


conversation_id`string` (Required, Path) The ID of the conversation.	Python Node.js cURL `python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) updated = client.conversations.update( "conv_xxx", metadata={"topic": "update"} ) print(updated)` `javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const updated = await client.conversations.update( "conv_xxx", { metadata: { topic: "update" } } ); console.log(updated);` `bash curl --location 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations/conv_xxx' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY' \ --data '{ "metadata": { "topic": "update" } }'`
metadata`object` (Required) The conversation metadata. This parameter completely overwrites the existing metadata. Specify up to 16 key-value pairs. The key can be up to 64 characters long, and the value can be up to 512 characters long.

Response parameters


created_at`integer` The Unix timestamp in milliseconds that indicates when the conversation was created.	`json { "created_at": 1771318152759, "id": "conv_xxx", "metadata": { "topic": "update" }, "object": "conversation" }`
id`string` The unique ID of the conversation.
metadata`object` The conversation metadata. This parameter stores additional information as key-value pairs. It can contain up to 16 pairs. The key can be up to 64 characters long, and the value can be up to 512 characters long.
object`string` The object type. The value is fixed as `conversation`.

Delete conversation

Deletes a specified conversation. Message items within the conversation are not deleted.

North China 2 (Beijing): DELETEhttps://dashscope.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}

Singapore: DELETEhttps://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}

conversation_idstring (Required, Path) The conversation ID. Python Node.js cURL python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) result = client.conversations.delete("conv_xxx") print(result) javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const result = await client.conversations.del( "conv_xxx" ); console.log(result); bash curl --location --request DELETE 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations/conv_xxx' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY'


conversation_id`string` (Required, Path) The conversation ID.	Python Node.js cURL `python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) result = client.conversations.delete("conv_xxx") print(result)` `javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const result = await client.conversations.del( "conv_xxx" ); console.log(result);` `bash curl --location --request DELETE 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations/conv_xxx' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY'`

Response parameters


deleted`boolean` Indicates whether the deletion was successful.	`json { "deleted": true, "id": "conv_xxx", "object": "conversation.deleted" }`
id`string` The ID of the deleted conversation.
object`string` The object type. The value is fixed as `conversation.deleted`.

Create items

Adds message items to a specified conversation.

North China 2 (Beijing): POSThttps://dashscope.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items

Singapore: POSThttps://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items

conversation_idstring (Required, Path) The ID of the conversation. Python Node.js cURL python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) items = client.conversations.items.create( "conv_xxx", items=[ { "type": "message", "role": "user", "content": [{"type": "input_text", "text": "Alice's major is teacher education"}], } ], ) print(items.data) javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const items = await client.conversations.items.create( "conv_xxx", { items: [ { type: "message", role: "user", content: [{ type: "input_text", text: "Alice's major is teacher education" }] } ] } ); console.log(items.data); bash curl --location 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations/conv_xxx/items' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY' \ --data '{ "items": [ { "type": "message", "role": "user", "content": [{ "type": "input_text", "text": "Alice's major is teacher education" }] } ] }'

itemsarray (Required) A list of message items. You can add up to 20 items at a time. Properties typestring (Required) The message type. Only message is supported. rolestring (Required) The role of the message. Instructions from the system and developer roles have a higher priority than instructions from the user role. The assistant role indicates messages that were generated by the model in previous interactions. Valid values are user, assistant, system, and developer. contentstring or array (Required) The message content. This parameter supports plain text strings or structured content lists, such as ResponseInputText object arrays. The list format can include various content types, such as text.


conversation_id`string` (Required, Path) The ID of the conversation.	Python Node.js cURL `python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) items = client.conversations.items.create( "conv_xxx", items=[ { "type": "message", "role": "user", "content": [{"type": "input_text", "text": "Alice's major is teacher education"}], } ], ) print(items.data)` `javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const items = await client.conversations.items.create( "conv_xxx", { items: [ { type: "message", role: "user", content: [{ type: "input_text", text: "Alice's major is teacher education" }] } ] } ); console.log(items.data);` `bash curl --location 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations/conv_xxx/items' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY' \ --data '{ "items": [ { "type": "message", "role": "user", "content": [{ "type": "input_text", "text": "Alice's major is teacher education" }] } ] }'`
items`array` (Required) A list of message items. You can add up to 20 items at a time. Properties type`string` (Required) The message type. Only `message` is supported. role`string` (Required) The role of the message. Instructions from the `system` and `developer` roles have a higher priority than instructions from the `user` role. The `assistant` role indicates messages that were generated by the model in previous interactions. Valid values are `user`, `assistant`, `system`, and `developer`. content`string or array` (Required) The message content. This parameter supports plain text strings or structured content lists, such as ResponseInputText object arrays. The list format can include various content types, such as text.

Response parameters


data`array[object]` A list of the created message items. Properties id`string` The unique ID of the message item. content`string or array` The message content. This can be a plain text string or a structured content list, such as a ResponseInputText object array. role`string` The role of the message. Valid values are `user`, `assistant`, `system`, and `developer`. status`string` The processing status of the message. Valid values are `in_progress`, `completed`, and `incomplete`. type`string` The type of the message item. The value is fixed as `message`.	`json { "data": [ { "content": [ { "text": "Alice's major is teacher education", "type": "input_text" } ], "id": "msg_xxx", "role": "user", "status": "completed", "type": "message" } ], "first_id": "msg_xxx", "has_more": false, "last_id": "msg_xxx" }`
first_id`string` The ID of the first message item in the list.
has_more`boolean` Indicates whether more data is available.
last_id`string` The ID of the last message item in the list.

List items

Lists all message items in a conversation.

North China 2 (Beijing): GEThttps://dashscope.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items

Singapore: GEThttps://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items


conversation_id`string` (Required, Path) The ID of the conversation.	Python Node.js cURL `python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) items = client.conversations.items.list("conv_xxx") print(items.data)` `javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const items = await client.conversations.items.list( "conv_xxx" ); console.log(items.data);` `bash curl --location 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations/conv_xxx/items?limit=10&order=asc' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY'`
after`string` (Optional) The pagination cursor. Returns only message items created after the specified message ID.
order`string` (Optional) The sort order. Valid values are `asc` for ascending and `desc` for descending. The default value is `desc`.
limit`integer` (Optional) The number of items to return. The value must be an integer from 1 to 100. The default value is 20.

Response parameters


data`array[object]` A list of the message items. Properties id`string` The unique ID of the message item. content`string or array` The message content. This can be a plain text string or a structured content list, such as a ResponseInputText object array. role`string` The role of the message. Valid values are `user`, `assistant`, `system`, and `developer`. status`string` The processing status of the message. Valid values are `in_progress`, `completed`, and `incomplete`. type`string` The type of the message item. The value is fixed as `message`.	json { "data": [ { "content": [ { "text": "Alice, a gentle and resilient woman, was born in Singapore. She is 20 years old, and her hobbies are music and chess.", "type": "input_text" } ], "id": "msg_7639f8f6-484b-454a-8125-96a3f40eb9e8", "role": "user", "status": "completed", "type": "message" }, { "content": [ { "text": "Alice's best friend is Bob", "type": "input_text" } ], "id": "msg_288594f6-6ef1-4519-94d4-a545ca311828", "role": "user", "status": "completed", "type": "message" } ], "first_id": "msg_7639f8f6-484b-454a-8125-96a3f40eb9e8", "has_more": false, "last_id": "msg_288594f6-6ef1-4519-94d4-a545ca311828", "object": "list" }
first_id`string` The ID of the first message item in the list.
has_more`boolean` Indicates whether more data is available.
last_id`string` The ID of the last message item in the list.
object`string` The object type. The value is fixed as `list`.

Retrieve item

Retrieves the details for a specified message item.

North China 2 (Beijing): GEThttps://dashscope.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items/{item_id}

Singapore: GEThttps://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items/{item_id}

item_idstring (Required, Path) The ID of the message item.


conversation_id`string` (Required, Path) The ID of the conversation.	Python Node.js cURL `python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) item = client.conversations.items.retrieve( "msg_xxx", conversation_id="conv_xxx" ) print(item)` `javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const item = await client.conversations.items.retrieve( "msg_xxx", { conversation_id: "conv_xxx" } ); console.log(item);` `bash curl --location 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations/conv_xxx/items/msg_xxx' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY'`
item_id`string` (Required, Path) The ID of the message item.

Response parameters


content`array[object]` A list of message content that contains one or more content objects. Properties type`string` The content type, such as `input_text` for user input text or `output_text` for model output text. text`string` The text content.	`json { "content": [ { "text": "Alice's major is teacher education", "type": "input_text" } ], "id": "msg_xxx", "role": "user", "status": "completed", "type": "message" }`
id`string` The unique ID of the message item.
role`string` The role of the message. Valid values are `user`, `assistant`, `system`, and `developer`.
status`string` The processing status of the message. Valid values are `in_progress`, `completed`, and `incomplete`.
type`string` The type of the message item. The value is fixed as `message`.

Delete item

Deletes a specified message item.

North China 2 (Beijing): DELETEhttps://dashscope.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items/{item_id}

Singapore: DELETEhttps://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/conversations/{conversation_id}/items/{item_id}

item_idstring (Required, Path) The ID of the message item.


conversation_id`string` (Required, Path) The ID of the conversation.	Python Node.js cURL `python import os from openai import OpenAI client = OpenAI( api_key=os.getenv("DASHSCOPE_API_KEY"), base_url="https://dashscope.aliyuncs.com/compatible-mode/v1", ) result = client.conversations.items.delete( "msg_xxx", conversation_id="conv_xxx" ) print(result)` `javascript import OpenAI from "openai"; const client = new OpenAI({ apiKey: process.env.DASHSCOPE_API_KEY, baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1", }); const result = await client.conversations.items.del( "msg_xxx", { conversation_id: "conv_xxx" } ); console.log(result);` `bash curl --location --request DELETE 'https://dashscope.aliyuncs.com/compatible-mode/v1/conversations/conv_xxx/items/msg_xxx' \ --header 'Authorization: Bearer $DASHSCOPE_API_KEY'`
item_id`string` (Required, Path) The ID of the message item.

Response parameters


deleted`boolean` Indicates whether the item was successfully deleted.	`json { "deleted": true, "id": "msg_xxx", "object": "conversation.item.deleted" }`
id`string` The ID of the deleted message item.
object`string` The object type. The value is fixed as `conversation.item.deleted`.

Use conversations in the Responses API

Use the conversation parameter of the Responses API to maintain context in multi-turn conversations.

Do not pass both previous_response_id and conversation at the same time. Otherwise, the following error occurs: [400] INVALID_REQUEST: Mutually exclusive parameters: Ensure you are only providing one of: previous_response_id or conversation.

Python

Node.js

python

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1",
)

conversation = client.conversations.create(
    items=[\
        {\
            "type": "message",\
            "role": "system",\
            "content": "Alice, a gentle and resilient woman, was born in Singapore. She is 20 years old, and her hobbies are music and chess.",\
        }\
    ]
)

response1 = client.responses.create(
    conversation=conversation.id, model="qwen3.7-plus", input="How old is Alice?"
)
print(f"First response: {response1.output_text}")

response2 = client.responses.create(
    conversation=conversation.id, model="qwen3.7-plus", input="What are her hobbies?"
)
print(f"Second response: {response2.output_text}")

javascript

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.DASHSCOPE_API_KEY,
  baseURL: "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1",
});

const conversation = await client.conversations.create({
  items: [\
    {\
      type: "message",\
      role: "system",\
      content: "Alice, a gentle and resilient woman, was born in Singapore. She is 20 years old, and her hobbies are music and chess."\
    }\
  ]
});

const response1 = await client.responses.create({
  conversation: conversation.id,
  model: "qwen3.7-plus",
  input: "How old is Alice?"
});
console.log("First response:", response1.output_text);

const response2 = await client.responses.create({
  conversation: conversation.id,
  model: "qwen3.7-plus",
  input: "What are her hobbies?"
});
console.log("Second response:", response2.output_text);

Limitations

When you create a conversation or add message items, the items array can contain up to 20 entries.
The metadata object can contain up to 16 key-value pairs. The key can be up to 64 characters long, and the value can be up to 512 characters long.

Previous: OpenAI compatible - EmbeddingNext: Create a tuning job

Is this page helpful?

Create conversation

Response parameters

Retrieve conversation

Response parameters

Update conversation

Response parameters

Delete conversation

Response parameters

Create items

Response parameters

List items

Response parameters

Retrieve item

Response parameters

Delete item

Response parameters

Use conversations in the Responses API

Limitations

Sales Support

Live-chat with our sales team or get in touch with a business development professional in your region.

Contact Sales

Technical Support

Open a ticket and get quick help from our technical team.

Open a Ticket >

We look forward to your suggestion.

Post a Suggestion > Report Abuse >

\ \ Hi, I'm Alibaba Cloud AI Assistant!\ \ I can help with questions and solutions.

Why Alibaba Cloud

About Alibaba Cloud

Asia Accelerator

Our Global Network

Global Offices

Trust Center

Case Studies

Analyst Reports

Products & Pricings

Pricing Calculator

ECS

SAS

Model Studio

Database

Security

SMS

Solutions

Financial Services

Retail Services

Media Services

Gaming Services

ISV Solutions

Engage

Developer Community

Partner Network

Startups

Marketplace

Join Alibaba Cloud

Resources & Support

Developer Learning Hub

Documentation Center

Training & Certification

Service Notices

Submit a Ticket

Security Report

Qwen Cloud

Careers About Us Privacy Policy Legal Integrity Compliance Reporting Channel Service Notices Links

Facebook
Linkedin
Twitter
YouTube
TikTok
contact.us@alibabacloud.com
Call Us Now
Discord

Careers About Us Privacy Policy Legal Integrity Compliance Reporting Channel Service Notices Links

Conversations API session management ​

Models ​

Models ​

GenAI Application ​

AI Service ​

AI Use Case ​

Overview ​

Why Alibaba Cloud ​

Customers and Insights ​

What's New ​

Products ​

Featured Products ​

Related Programs ​

Solutions ​

Pricing ​

Overview & Tools ​

Optimize your cost ​

Resources ​

Technical Resources ​

Training&Certification ​

Developer Hub ​

Partners ​

Marketplace ​

Find a Partner ​

Become a Partner ​

Support ​

Support & Professional Services ​

Contact us ​

Language ​

Locale ​

Create conversation ​

Response parameters ​

Retrieve conversation ​

Response parameters ​

Update conversation ​

Response parameters ​

Delete conversation ​

Response parameters ​

Create items ​

Response parameters ​

List items ​

Response parameters ​

Retrieve item ​

Response parameters ​

Delete item ​

Response parameters ​

Use conversations in the Responses API ​

Limitations ​

Sales Support ​

Technical Support ​

Connect & Report Abuse ​

Conversations API session management

Models

Models

GenAI Application

AI Service

AI Use Case

Overview

Why Alibaba Cloud

Customers and Insights

What's New

Products

Featured Products

Related Programs

Solutions

Pricing

Overview & Tools

Optimize your cost

Resources

Technical Resources

Training&Certification

Developer Hub

Partners

Marketplace

Find a Partner

Become a Partner

Support

Support & Professional Services

Contact us

Language

Locale

Create conversation

Response parameters

Retrieve conversation

Response parameters

Update conversation

Response parameters

Delete conversation

Response parameters

Create items

Response parameters

List items

Response parameters

Retrieve item

Response parameters

Delete item

Response parameters

Use conversations in the Responses API

Limitations

Sales Support

Technical Support

Connect & Report Abuse