同步调用 API 参考

本文介绍如何通过 OpenAI 兼容模式的 Responses API 同步调用阿里云百炼应用（智能体应用、工作流应用）。适用于需要即时获取结果的实时交互场景，可轻松复用现有的 OpenAI 代码库，或快速集成来自 OpenAI 生态的各类工具。

本文仅适用于旧版智能体应用（Agent 1.0）。如果您使用的是新版智能体应用（Agent 2.0），调用本文描述的 API 会返回版本不兼容错误，请参阅新版智能体应用 API。如何区分应用版本：在应用管理页面创建智能体应用时，系统会提示您选择 Agent 2.0（推荐）或 Agent 1.0。

相关参考

异步调用：对于耗时较长的任务，请参阅异步调用 API 参考。
DashScope API：如需获取更全面的功能与更高的性能，请参阅 DashScope API。

前提条件

已获取 API Key 并配置到环境变量
已创建阿里云百炼应用并获取应用 ID
如果通过 SDK 调用，还需要安装 OpenAI Python SDK

接入地址

SDK base_url: https://dashscope.aliyuncs.com/api/v2/apps/agent/{APP_ID}/compatible-mode/v1/
HTTP Endpoint: POST https://dashscope.aliyuncs.com/api/v2/apps/agent/{APP_ID}/compatible-mode/v1/responses

请将 {APP_ID} 替换为实际的应用 ID。

在线调试：通过应用卡片 -> 发布 -> API 调试路径进入调试页面后，填写参数并点击运行即可。

快速上手：发送第一条消息

from openai import OpenAI
import os

api_key = os.getenv("DASHSCOPE_API_KEY")
app_id = 'APP_ID'  # 替换为实际的应用 ID
base_url = f'https://dashscope.aliyuncs.com/api/v2/apps/agent/{app_id}/compatible-mode/v1/'

client = OpenAI(
    api_key=api_key,
    base_url=base_url
)

response = client.responses.create(
    input="你是谁？",
)

print(response.model_dump_json(indent=2))

当您使用 Python SDK 并传入简单字符串（如 input="你好"）时，SDK 会自动将其包装成 API 所需的完整 JSON 格式。如果您直接使用 cURL 或其他 HTTP 客户端，则需要手动构建完整 JSON 结构。

请求参数

参数	类型	必选	说明
input	string/array	是	用户输入内容。可以是简单字符串或消息数组。
model	string	否	模型名称，不影响实际调用的模型。
stream	boolean	否	是否开启流式输出，默认 `false`。
previous_response_id	string	否	上一次响应的 ID，用于多轮对话。

响应对象

参数	类型	说明
id	string	响应唯一标识。
output	array	输出消息列表。
status	string	响应状态，如 `completed`。
usage	object	Token 使用信息。

错误码

如果调用失败并返回报错信息，请参阅错误码文档进行解决。

​前提条件

​接入地址

​快速上手：发送第一条消息

​请求参数

​响应对象

​错误码

前提条件

接入地址

快速上手：发送第一条消息

请求参数

响应对象

错误码