本文档介绍静态配置API接口的输入输出参数。调用该接口可获取智能体的开场白和开场问题，您可根据这些数据自定义实现UI效果。

提供APIKey接入和TOP网关接入两种方式，两种接入方式有不同的URL。

APIKey接入(推荐)

1. 获取API Key

   1. 打开并登录联网问答智能体-APIKey 管理。

   2. 单击创建API Key按钮。

   3. 在弹出的名称文本框中填写API Key 名称，单击创建。

   说明：请妥善保存好API Key，强烈建议您不要将其直接写入到调用模型的代码中。

2. 签名构造

API Key 签名鉴权方式要求在 HTTP 请求 header 中按如下方式添加 Authorization:

Authorization: Bearer <API_KEY>

火山引擎TOP网关接入

此接入方式基于火山引擎IAM的AK/SK鉴权，统一使用 ServiceName=volc_torchlight_api

1. 接口验签及请求公共参数逻辑遵循火山引擎官网的统一规范，详情请参见：签名方法--API签名调用指南-火山引擎；

2. 开通账号权限后，可获取AccessKey进行验签，详情请参见：Access Key(密钥)管理--API访问密钥(Access Key)-火山引擎。

注意：

1. 若使用主账号接入，可跳过此步骤，忽略此前提；(使用主账号有权限过大的风险，不建议直接使用)

2. 若使用子账号接入，需要首先登录控制台，开通接口访问权限；否则会报错100013:AccessDenied错误;

3. 开通接口权限步骤：

   1. 使用火山引擎控制台主账号，登录控制台；

   2. 点击用户头像进入访问控制模块，在用户模块点击管理按钮进入子账号权限管理界面；

   3. 切换到权限TAB，点击添加权限按钮，在搜索栏输入“TorchlightApiFullAccess”权限，并选中确认；

   4. 若有多个子账号访问平台，需对每个子账号进行相应权限配置。

4. 若使用火山引擎TOP网关接入，需要请求体整体长度不超过8M。

请求结构

获取智能体配置

URL

请求体

GetBotMetaRequest

响应体

GetBotMetaResponse

BotMeta

请求示例

{
  "BotId": "7429717161499017747"
}

响应示例

非流式响应

{
    "ResponseMetadata": {
        "RequestId": "你的logid",
        "Action": "GetBotMeta",
        "Version": "2024-01-01",
        "Service": "volc_torchlight_api",
        "Region": "cn-north-1"
    },
    "Result": {
        "BotMeta": {
            "OpeningRemark": "你的开场白",
            "OpeningQuestions": [
                "你的开场问题1",
                "你的开场问题2",
                "你的开场问题3",
            ]
        }
    }
}

错误响应

响应格式如下：

{
    "ResponseMetadata": {
        "RequestId": "202210271151020102121450321B8D2A21",
        "Action": "ScanSyncArticles",
        "Version": "2023-01-01",
        "Service": "volc_torchlight_api",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 100010,
            "Code": "SignatureDoesNotMatch",
            "Message": "The request signature we calculated does not match the signature you provided. Check your Secret Access Key and signing method. Consult the service documentation for details."
        }
    }
}

如何获取logid

RequestID是每次API请求的唯一标识，当出现了无法自助解决的问题时，可以提供请求的RequestID，我们将协助进行故障排查。

• RequestID格式为：20241211184452633DBFC9B5FB220BDEBF。

• 以下为获取requestID的几种方式：

  • 响应体ResponseMetadata-RequestID，具体响应结构可以参见文档：API公共错误码

  • 响应头X-Tt-Logid