异步调用API参考

智能体应用配置

插件参数传递：在应用内选择指定插件工具，发布应用。

工作流应用配置

API 调用

• 自定义参数：调用时通过biz_params传递，参数名和类型要与应用内的参数配置保持一致。

  Python

  from openai import AsyncOpenAI
  import asyncio
  import os
  
  # 若没有配置环境变量，可用百炼API Key将下行替换为：api_key="sk-xxx"。但不建议在生产环境中直接将API Key硬编码到代码中，以减少API Key泄露风险。
  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 = AsyncOpenAI(
    api_key=api_key,
    base_url=base_url
  )
  async def main():
    # 异步调用
    response = await client.responses.create(
      input="你好",
      extra_body={
          "biz_params": {"city": "北京"} 
      },
      background=True
    )
      
    # 打印完整的响应JSON对象
    print(response.model_dump_json(indent=2))
  
  # 运行异步主函数
  if __name__ == "__main__":
    asyncio.run(main())

  curl

  #!/bin/bash
  # ==================== 配置区域 ====================
  # 若没有配置环境变量，请将 ${DASHSCOPE_API_KEY} 替换为实际的阿里云百炼 API Key
  # 但不建议在生产环境中直接将 API Key 硬编码到代码中，以减少 API Key 泄露风险
  # {APP_ID} 替换为实际的应用 ID
  
  # ==================== 调用 API ====================
  curl --location "https://dashscope.aliyuncs.com/api/v2/apps/agent/{APP_ID}/compatible-mode/v1/responses" \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${DASHSCOPE_API_KEY}" \
  --data '{
      "input": "你是谁？",
      "background": true,
      "biz_params": {
          "city": "杭州"
      }
  }'

• 插件参数：调用时通过biz_params传递，user_defined_params传递工具参数，user_defined_tokens传递鉴权参数，参数名和类型要与工具参数配置保持一致。

  Python

  """
  阿里云百炼应用调用示例
  异步调用
  """
  from openai import AsyncOpenAI
  import asyncio
  import os
  
  # ==================== 配置区域 ====================
  
  # API Key 配置
  # 若没有配置环境变量，可将下行替换为：api_key="sk-xxx"
  # 但不建议在生产环境中直接将 API Key 硬编码到代码中，以减少泄露风险
  api_key = os.getenv("DASHSCOPE_API_KEY")
  
  # 应用 ID（在百炼控制台 -> 应用 -> 发布渠道 -> API 中获取）
  app_id = 'YOUR_APP_ID'  # 替换为实际的应用 ID
  
  # Base URL
  base_url = f'https://dashscope.aliyuncs.com/api/v2/apps/agent/{app_id}/compatible-mode/v1/'
  
  # ==================== 客户端初始化 ====================
  
  client = AsyncOpenAI(
      api_key=api_key,
      base_url=base_url
  )
  
  # ==================== 业务参数配置（可选）====================
  
  # biz_params 用于传递自定义参数给应用中的工具/插件
  # YOUR_TOOL_ID 需要替换为实际的工具 ID（在百炼控制台的插件工具详情页获取）
  biz_params = {
      # 自定义参数：传递给指定工具的参数
      "user_defined_params": {
          "YOUR_TOOL_ID": {  # 替换为实际的工具 ID
              "article_index": 9   # 自定义参数，根据工具需求设置
          }
      },
      # 自定义 Token：为指定工具提供认证信息，YOUR_TOKEN替换为示例的认证 Token
      "user_defined_tokens": {
          "YOUR_TOOL_ID": {  # 替换为实际的工具 ID
              "user_token": "YOUR_TOKEN" # 工具所需的认证 Token
          }
      }
  }
  
  # ==================== 主函数 ====================
  
  async def main():
      """异步调用 Agent 应用"""
      
      # 发起异步请求
      # - input: 用户输入的问题或指令
      # - extra_body: 额外参数，包括 biz_params（业务参数）
      # - background: True 表示后台异步执行
      response = await client.responses.create(
          input="你好",
          extra_body={
              "biz_params": biz_params
          },
          background=True
      )
      
      # 打印完整的响应 JSON 对象
      print(response.model_dump_json(indent=2))
  
  
  # ==================== 程序入口 ====================
  
  if __name__ == "__main__":
      asyncio.run(main())
  

  curl

  #!/bin/bash
  # ==================== 配置区域 ====================
  # 若没有配置环境变量，请将 ${DASHSCOPE_API_KEY} 替换为实际的阿里云百炼 API Key
  # 但不建议在生产环境中直接将 API Key 硬编码到代码中，以减少 API Key 泄露风险
  
  APP_ID="YOUR_APP_ID"  # 替换为实际的应用 ID
  
  # ==================== 调用 API ====================
  curl --location "https://dashscope.aliyuncs.com/api/v2/apps/agent/${APP_ID}/compatible-mode/v1/responses" \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${DASHSCOPE_API_KEY}" \
  --data '{
      "input": "你是谁？",
      "background": true,
      "biz_params": {
          "user_defined_params": {
              "YOUR_PLUGIN_ID": {
                  "article_index": 9
              }
          },
          "user_defined_tokens": {
              "YOUR_PLUGIN_ID": {
                  "user_token": "YOUR_TOKEN"
              }
          }
      }
  }'
  
  # ==================== 参数说明 ====================
  # biz_params 用于传递自定义参数给 Agent 中的工具/插件：
  #
  # user_defined_params - 自定义参数
  #   YOUR_PLUGIN_ID: 替换为实际的工具 ID
  #   article_index: 自定义参数名和值，根据工具需求设置
  #
  # user_defined_tokens - 自定义 Token（鉴权信息）
  #   YOUR_PLUGIN_ID: 替换为实际的工具 ID
  #   user_token: 工具所需的认证 Token