工作流应用 API 参考

本文介绍通过 DashScope 接口调用阿里云百炼工作流应用时的输入输出参数。

前置准备

开始前，请确保您已完成以下操作：

创建应用： 前往应用管理创建阿里云百炼工作流应用并获取应用 ID。
获取 API Key： 通过密钥管理获取并配置环境变量。
安装 SDK（可选）： 若使用 SDK 调用，请安装相应语言的 DashScope SDK。

调用方式

HTTP 接口调用 请求地址：POST https://dashscope.aliyuncs.com/api/v1/apps/{APP_ID}/completion
其中 APP_ID 需替换为您的实际应用 ID。
SDK 调用 Python/Java SDK 已默认配置正确的 endpoint。

请求体

参数	类型	必选	说明
app_id	string	是	应用标识。在应用管理的应用卡片上获取。
prompt	string	是	用户的输入指令。HTTP 调用时放入 `input` 对象中。
session_id	string	否	历史对话标识。传入时请求将自动携带云端存储的对话历史。
workspace	string	否	业务空间标识。仅调用子业务空间的应用时需传递。
stream	boolean	否	是否以流式输出方式回复，默认 `false`。
incremental_output	boolean	否	流式输出模式下是否开启增量输出，默认 `false`。
biz_params	object	否	工作流应用自定义参数传递。

代码示例

import os
from http import HTTPStatus
from dashscope import Application

response = Application.call(
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    app_id='APP_ID',  # 替换为实际的应用 ID
    prompt='你好')

if response.status_code != HTTPStatus.OK:
    print(f'request_id={response.request_id}')
    print(f'code={response.status_code}')
    print(f'message={response.message}')
else:
    print(response.output.text)

响应对象

参数	类型	说明
status_code	string	返回的状态码。200 表示请求成功。
request_id	string	本次调用的唯一标识符。
code	string	错误码，调用成功时为空值。
message	string	错误详细信息，请求成功则忽略。
output	object	调用结果信息。
usage	object	本次请求使用的数据信息。

output 属性

参数	类型	说明
text	string	模型生成的回复内容。
finish_reason	string	完成原因。`stop` 为自然结束。
session_id	string	当前对话的唯一标识。

usage 属性

参数	类型	说明
models	array	本次调用的模型信息。
models[].model_id	string	模型 ID。
models[].input_tokens	integer	输入 Token 数。
models[].output_tokens	integer	输出 Token 数。

QPM 限制

单应用默认 QPM（每分钟请求数）为 15000。

错误码

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

​前置准备

​调用方式

​请求体

​代码示例

​响应对象

​output 属性

​usage 属性

​QPM 限制

​错误码

前置准备

调用方式

请求体

代码示例

响应对象

output 属性

usage 属性

QPM 限制

错误码