You need to enable JavaScript to run this app.
文档中心
复制全文
下载 pdf
API参考
获取静态配置API
复制全文
下载 pdf
获取静态配置API
本文档介绍获取静态配置API接口的输入输出参数。调用该接口可获取智能体在控制台配置的开场白和开场问题,您可根据这些数据自定义实现UI效果。​
认证方式​
接口详情​
URL​
​
URL​
  • API Key接入:https://open.feedcoopapi.com/agent_api/bot_meta/get​
  • Access Key接入:https://mercury.volcengineapi.com?Action=GetBotMeta&Version=2026-01-01​
Method​
POST​
Header​
  • API Key接入:​
  • Authorization: Bearer <API_KEY>​
  • Content-Type:application/json​
  • ServiceName: ask_echo​
  • Access Key接入:​
  • Content-Type:application/json​
  • 此接入方式基于火山引擎访问控制的AK/SK鉴权,统一使用 ServiceName=ask_echo,接口验签及请求公共参数逻辑遵循火山引擎官网的统一规范,详情请参见:签名方法--API签名调用指南-火山引擎;​
​
请求体​
GetBotMetaRequest​
​
参数​
类型​
必需​
描述​
BotId​
String​
是​
智能体ID,在控制台创建智能体后获取,控制台地址:https://console.volcengine.com/ask-echo/my-agent​
​
响应体​
GetBotMetaResponse​
​
字段​
类型​
必需​
说明​
BotMeta​
Object​
是​
响应的唯一标识符​
​
BotMeta​
​
字段​
类型​
必需​
说明​
OpeningRemark​
String​
否​
开场白,控制台配置详细信息​
OpeningQuestions​
[]String​
否​
开场问题,控制台配置详细信息​
​
请求示例​
​
{​
"BotId": "7429717161499017747"​
}​
​
响应示例​
非流式响应​
​
{​
"ResponseMetadata": {​
"RequestId": "你的logid",​
"Action": "GetBotMeta",​
"Version": "2026-01-01",​
"Service": "ask_echo",​
"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​
最近更新时间:2026.08.11 19:54:19
这个页面对您有帮助吗?
有用
有用
无用
无用