通过API调用工作流

获取调用路径

工作流的调用路径获取步骤如下：

1. 登录ModelArts Studio平台，单击“AGENT开发”进入Agent开发平台。
2. 在“工作台 > 工作流”页面，单击所需工作流的“ > 调用路径”。
   图1 获取工作流调用路径-1

   

3. 在“调用路径”页面，单击“复制路径”即可获取调用路径。

   其中，conversation_id参数为会话ID，唯一标识每个会话的标识符，可将会话ID设置为任意值，使用标准UUID格式，例如：下图中的:conversation_id可以替换成550e8400-e29b-41d4-a716-446655440000。

   图2 获取工作流调用路径-2

   

获取Token

参考《API参考》文档“如何调用REST API > 认证鉴权”章节获取Token。

使用Postman调用API

1. 在Postman中新建POST请求，并填入工作流的调用路径，详见获取调用路径。
2. 填写请求Header参数。
   • 参数名为Content-Type，参数值为application/json。
   • Header参数X-Auth-Token为必填项，参数值为获取Token中获取的Token值。
   图3 填写请求Header
   
3. 在Postman中选择“Body > raw”选项，请求Body填写示例如下。
   其中，inputs参数为用户提出的问题，作为工作流的输入。工作流有插件时，添加plugin_configs参数，plugin_id参数为插件ID，获取方式详见管理插件。

   带插件请求
   { 
     "inputs": {
       "query": "你好"
     },
     "plugin_configs": [
       {
         "plugin_id": "xxxxxxxxx",
         "config": {
           "key": "value"
         }
       }
     ]
   }
   不带插件请求
   { 
     "inputs": {
       "query": "介绍下北京"
     }
   }

4. 单击Postman界面“Send”，发送请求。当接口返回状态为200时，表示应用API调用成功。

   工作流带有提问器节点时返回示例如下所示。

   {
       "conversation_id": "2c90493f-803d-431d-a197-57543d414317",
       "messages": [
           {
               "role": "assistant",
               "content": "你好"
           }
       ],
       "status": {
           "code": 1,
           "desc": "succeeded"
       },
       "start_time": 1734336269313,
       "end_time": 1734336270908
   }

   工作流不带提问器节点时的返回示例如下所示。

   {
       "conversation_id": "2c90493f-803d-431d-a197-57543d414317",
       "outputs": {
           "responseContent": "你好！有什么我可以帮助你的吗？"
       },
       "messages": [],
       "status": {
           "code": 1,
           "desc": "succeeded"
       },
       "start_time": 1734337068533,
       "end_time": 1734337082545
   }