
# 使用API调用单/多智能体
在AgentArts平台上开发完成智能体后，其最终目的是要融入企业的核心业务流中。为了实现上述集成，AgentArts提供了标准的RESTful API。完整的调用架构分为两步：
1. 认证鉴权：在AgentArts平台获取鉴权参数Authorization（新版AgentArts部署区域为西南-贵阳一，使用Authorization参数鉴权，而非老版本的使用Token鉴权）。
2. 业务调用：携带鉴权信息，调用单/多智能体接口。
#### 前置检查
- 已开通AgentArts服务。
- 已接入可用模型。调用智能体/工作流API时不支持使用平台赠送的免费token，确保配置的模型满足以下任一条件：
  - 接入华为云MaaS服务模型并配置模型API Key（平台默认模型来源），操作请参考[接入华为云MaaS服务付费模型](https://support.huaweicloud.com/bestpractice-agentarts/agentarts_06_0095.html)。
  
  - 已在智能体/工作流中自行对接外部第三方模型，操作请参考[手动接入和使用OpenAI协议模型](https://support.huaweicloud.com/bestpractice-agentarts/agentarts_06_0096.html)。
   
未接入MaaS模型且未使用第三方模型时，调用API将返回"Model call failed"报错。
#### 步骤一：部署智能体
**本示例中的智能体部署时采用API Key认证，API调用也采用该方法。**
1. 登录[AgentArts智能体平台](https://console.huaweicloud.com/agentarts/#/home/overview)。
2. 在左侧导航栏中选择"开发中心 \> 智能体管理"，选择需要调用的智能体。单击智能体名称进入智能体编辑页面。在"提交版本"或者"更新版本"时，需要勾选"部署至实例"选项。勾选后单击"确定"。 
   图1勾选"部署至实例"   
   ![](https://support.huaweicloud.com/bestpractice-agentarts/zh-cn_image_0000002687949280.png "点击放大")
   
   
3. 入站身份认证选择"API Key"，并勾选日志记录、指标、调用链。其余配置可以使用默认值。 
   图2选择入站身份认证   
   ![](https://support.huaweicloud.com/bestpractice-agentarts/zh-cn_image_0000002717389031.png "点击放大")
   
   
4. 单击"确定"部署智能体。
 
 #### 步骤二：获取API调用凭证（获取Authorization）
1. 登录[AgentArts智能体平台](https://console.huaweicloud.com/agentarts/#/home/overview)。
2. 在左侧导航栏中选择"开发中心 \> 智能体管理"选择需要调用的智能体，并复制ID。 
   对应的智能体需要是"已提交"状态。如果显示"未提交"请单击智能体的名称，进入编辑页面，进行"提交版本"操作及部署。未部署状态的智能体无法获取调用凭证。
   图3获取ID   
   ![](https://support.huaweicloud.com/bestpractice-agentarts/zh-cn_image_0000002687789454.png "点击放大")
   图4提交版本   
   ![](https://support.huaweicloud.com/bestpractice-agentarts/zh-cn_image_0000002687949290.png "点击放大")
   
   
3. 获取ID后，在"部署运行 \> 智能体运行时"页面搜索ID。 
   图5搜索ID   
   ![](https://support.huaweicloud.com/bestpractice-agentarts/zh-cn_image_0000002717548929.png "点击放大")
   
   
4. 单击ID名称，进入基本信息页面，找到"访问与权限控制"对应的URN。单击URN名称。 
   图6单击URN名称   
   ![](https://support.huaweicloud.com/bestpractice-agentarts/zh-cn_image_0000002687949274.png "点击放大")
   
   
5. 在页面中获取API Key的取值。 
   获取API Key的值后，在API Key值前加上"Bearer "即为Authorization的值（注意Bearer后有一个空格）。
   图7获取API Key取值   
   ![](https://support.huaweicloud.com/bestpractice-agentarts/zh-cn_image_0000002717389043.png "点击放大")
   
   
 
#### 步骤三：调用智能体
**API接口：**
POST /runtimes/{runtime_name}/invocations
**API接口获取方法：**
1. 登录[AgentArts智能体平台](https://console.huaweicloud.com/agentarts/#/home/overview)。
2. 在左侧导航栏中选择"开发中心 \> 智能体管理"，在"单智能体"页签选择所需的单智能体应用。
3. 复制调用路径。（注意智能体需要经过发布，显示为"已提交"状态） 
   图8获取API接口   
   ![](https://support.huaweicloud.com/bestpractice-agentarts/zh-cn_image_0000002717389059.png "点击放大")
   
   
**核心请求参数说明：**
表1请求Header参数 
| 参数                        | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| Authorization             | 是    | String | **参数解释**： 鉴权参数。获取方式请参考[步骤二：获取API调用凭证（获取Authorization）]。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。                                                                                                                                                                                                                                                                                                              |
| X-Invoke-Mode             | 否    | String | **参数解释**： 该参数用于标识运行时运行的模式。 **约束限制**： 不涉及。 **取值范围**： - X-Invoke-Mode的值为debug时，运行模式为调试模式。调试模式会生成日志、详细的执行步骤，便于排查问题。   - X-Invoke-Mode的值为published时，运行模式为发布模式。    **默认取值**： published。 |
| x-hw-agentarts-session-id | 是    | String | **参数解释**： 会话ID，每个会话的唯一标识符。用户可将会话ID设置为任意字符串，例如"123e4567e89b12d3a456426614174000"，由用户自定义，无需在其他地方获取。 **约束限制**： 不涉及。 **取值范围**： 由英文、数字、"-"、"_"组成，不超过64位字符。 **默认取值**： 不涉及。                                                                                                                                                                                                                                                                                 |
| X-Request-Id              | 否    | String | **参数解释**： 调用链ID，每个请求的唯一标识符。用于日志中跟踪整个请求的调用链路。用户可将调用链ID设置为任意字符串，例如"123e4567e89b12d3a4564266141740"，无需在其他地方获取。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。                                                                                                                                                                                                                                                                                             |
| Content-Type              | 是    | String | **参数解释**： 发送的实体的MIME类型。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： application/json。                                                                                                                                                                                                                                                                                                                                                                    |
   
表2请求Body参数 
| 参数    | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| query | 否    | String | **参数解释**： 用户请求的问题。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 |
   
**Python调用示例：**
```
import requests
import json
# 替换为真实的API接口
url = "https://{endpoint}/runtimes/{runtime_name}/invocations"
# 最简请求体：仅包含 query
payload = json.dumps({
    "query": "你好"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': '您的Authorization，格式为Bearer {api_key}',
  'x-hw-agentarts-session-id': '您的会话ID，由用户自定义，由英文、数字、“-”、“_”组成，不超过64位字符。'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
```
**cURL调用示例：**
针对不同操作系统，命令的转义和换行符有所不同。
- Windows 在CMD（命令提示符）中执行如下命令：
  ```
  curl -X POST "https://{endpoint}/runtimes/{runtime_name}/invocations" ^
    -H "Content-Type: application/json" ^
    -H "Authorization: 您的Authorization，格式为Bearer {api_key}" ^
    -H "x-hw-agentarts-session-id: 您的会话ID" ^
    -d "{ \"query\": \"你好\" }"
  ```
  
- Linux/macOS 在Terminal（终端）中执行如下命令：
  ```
  curl -X POST "https://{endpoint}/runtimes/{runtime_name}/invocations" \
    -H "Content-Type: application/json" \
    -H "Authorization: 您的Authorization，格式为Bearer {api_key}" \
    -H "x-hw-agentarts-session-id: 您的会话ID" \
    -d '{
      "query": "你好"
    }'
  ```
  
 
