更新时间:2025-07-28 GMT+08:00

使用API调用Agent应用

Agent开发平台支持将创建好的应用进行API调用。在调用应用前,请先参考为Agent应用提升技能,完成创建应用操作。

获取调用路径

应用的调用路径获取步骤如下:

  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请求,并填入应用的API接口。
  2. 填写请求Header参数。
    • 参数名为Content-Type,参数值为application/json。
    • Header参数X-Auth-Token为必填项,参数值为获取Token中获取的Token值。
    图3 填写请求Header

  3. 在Postman中选择“Body > raw”选项,请求Body填写示例如下。其中,query参数为用户提出的问题,作为应用的输入。
    { 
      "query": "介绍下北京的景点"
    }
  4. 单击Postman界面“Send”,发送请求。当接口返回状态为200时,表示应用API调用成功,响应示例如下:
    data:{"event":"start","createdTime":1744636611503}
    
    data:{"event":"message","content":"北京","createdTime":1744636611816}
    
    data:{"event":"message","content":"是","createdTime":1744636611854}
    
    data:{"event":"message","content":"中国的","createdTime":1744636611890}
    
    data:{"event":"message","content":"首都","createdTime":1744636611925}
    
    ...
    
    data:{"event":"message","content":"随时","createdTime":1744636624119}
    
    data:{"event":"message","content":"告诉我","createdTime":1744636624154}
    
    data:{"event":"message","content":"。","createdTime":1744636624190}
    
    data:{"event":"statistic_data","latency":{"overall":13.17},"createdTime":1744636624265}
    
    data:{"event":"summary_response","content":"北京是中国的首都,拥有丰富的历史文化遗产和现代化的城市景观。以下是一些著名的旅游景点推荐:\n\n### 历史文化景点\n- **故宫**\n  - 特色: 世界上最大的宫殿复合体,明清两代的皇宫,展示了中国古代的建筑艺术和皇家文化。\n  - 建议: 建议预留至少半天时间参观,最好提前在线购票以避免排队。\n\n- **天安门广场**\n  - 特色: 世界上最大的城市广场,周围有人民英雄纪念碑、毛主席纪念堂等重要建筑。\n  - 建议: 早晨或傍晚时分参观,可以避开人流高峰。\n\n- **颐和园**\n  - 特色: 中国保存最完整的皇家园林,以昆明湖和万寿山为基础,融合了江南园林的设计风格。\n  - 建议: 适合全家出游,可以乘坐游船游览昆明湖。\n\n### 现代景点\n- **鸟巢和水立方**\n  - 特色: 2008年北京奥运会的主要场馆,现在成为了北京的标志性建筑。\n  - 建议: 晚上参观可以看到灯光秀,非常壮观。\n\n- **798艺术区**\n  - 特色: 集合了众多艺术展览和创意工作室,是艺术爱好者的天堂。\n  - 建议: 适合下午或傍晚时分参观,可以在此享受艺术氛围。\n\n- **三里屯**\n  - 特色: 北京最时尚的购物和娱乐区,有众多国际品牌店和餐厅。\n  - 建议: 适合晚上前往,体验北京的夜生活。\n\n希望这些信息对您的旅行计划有所帮助!如果您需要更详细的行程规划或其他信息,请随时告诉我。","role":"assistant","createdTime":1744636624266}
    
    data:{"event":"done","createdTime":1744636624276}