You need to enable JavaScript to run this app.
文档中心
Viking AI 搜索

Viking AI 搜索

复制全文
下载 pdf
用户指南
管理API Key
复制全文
下载 pdf
管理API Key
AI 搜索引擎的数据面服务接口(包括应用配置的搜索、对话、推荐服务调用接口和数据集的数据上传、删除和查询接口)均可以使用API Key进行鉴权。您可以在控制台创建、管理和查看API Key,并获取API Key用于构造接口鉴权。​
​​
Viking AI 搜索后续将使用火山引擎通用 API Key​
自 2026年7月14日 起,AI 搜索引擎后续将使用火山引擎通用 API Key。迁移过渡期兼容期,AI 搜索历史存量密钥继续可用。完成密钥迁移后,建议删除旧密钥以降低安全风险。​
​
概述​
Viking AI 搜索的数据面服务接口支持使用 API Key 进行鉴权。数据面服务接口包括数据集的数据上传、删除和查询接口,以及应用的搜索、对话、推荐等调用接口。​
新版 API Key 能力支持两类 API Key:​
  • 火山引擎通用 API Key:推荐新用户和新业务使用。该类型 API Key 由火山引擎统一的 API Key 能力创建和管理,可用于新版数据导入与 API 调用场景。​
  • 历史 AI 搜索 API Key:用于兼容存量业务。已接入历史 AI 搜索 API Key 的业务可以继续使用,但建议逐步迁移到火山引擎通用 API Key。​
​
安全提示​
API Key 具备调用服务接口的权限。请勿将 API Key 写入前端代码、移动端客户端、公开仓库、日志或工单截图中。建议在服务端通过环境变量或密钥管理服务保存和使用 API Key。​
​
API Key 类型说明​
​
类型​
推荐使用对象​
管理入口​
说明​
火山引擎通用 API Key​
新接入用户、新业务、新集成​
火山引擎通用 API Key 管理页​
推荐使用。适用于新版数据导入与 API 调用场景。​
历史 AI 搜索 API Key​
已接入历史鉴权方式的存量业务​
Viking AI 搜索控制台的 API Key 管理页​
继续兼容存量调用。建议评估迁移到火山引擎通用 API Key。​
​
创建 API Key​
Viking AI 搜索后续将使用火山引擎通用 API Key​
自 2026年7月14日 起,AI 搜索引擎后续将使用火山引擎通用 API Key,新创建的 API Key 都会是火山引擎通用 API Key。​
  1. 进入 Viking AI 搜索 控制台。​
  1. 在左侧导航栏选择 API Key 管理。​
  1. 单击 创建火山引擎通用 API Key。​
​​​
  1. 输入 API Key 名称,并点击「确定」​
​​​
​
  1. 完成身份认证后,界面会展示新建的 API Key。​
  1. 创建完成后,妥善保存 API Key。出于安全考虑,完整 Key 通常仅在创建时展示一次。定期删除和轮换密钥。关闭弹窗后,请到火山引擎 IAM 服务查看完整密钥(https://console.volcengine.com/iam/keymanage)。​
​​​
火山引擎 API Key​
查看 火山引擎通用 API Key​
说明​
您也可以直接通过IAM 服务查看火山引擎通用 API 密钥 —— https://console.volcengine.com/iam/keymanage​
  1. 进入 Viking AI 搜索 控制台。​
  1. 在左侧导航栏选择 API Key 管理。​
  1. 平台会展示当前账号下所有已创建的 Viking AI 搜索引擎API Key 列表。若想查看火山引擎通用 API Key,请点击「查看火山引擎通用 API Key」跳转到火山引擎 IAM 界面。​
​​​
​​​
​
禁用 火山通用 API Key​
请查看: https://docs.volcengine.com/docs/6257/64983​
​
删除 火山通用 API Key​
请查看: https://docs.volcengine.com/docs/6257/64983​
​
Viking AI 搜索 API Key(历史兼容)​
迁移 Viking AI 搜索 API Key​
如果您的业务仍在使用历史 AI 搜索 API Key,可以在 Viking AI 搜索控制台的 API Key 管理页查看已有 Key,并按需选择使用。我们建议您高优迁移至火山引擎通用 API Key。​
​
从历史 AI 搜索 API Key 迁移到火山引擎通用 API Key​
  1. 创建一个新火山引擎通用 API Key。​
  1. 在测试环境中将请求头中的 API Key 替换为新的火山引擎通用 API Key。​
  1. 验证数据上传、数据删除、数据查询、搜索、对话和推荐等核心接口。​
  1. 确认业务日志、监控和告警均正常。​
  1. 在生产环境灰度切换到新的 API Key。​
  1. 确认无异常后,停止使用旧的历史 AI 搜索 API Key 并删除 AI 搜索 API Key。​
​
查看 Viking AI 搜索 API Key​
  1. 进入 Viking AI 搜索 控制台。​
  1. 在左侧导航栏选择 API Key 管理。​
  1. 平台会展示当前账号下所有已创建的 Viking AI 搜索引擎API Key 列表。若想查看火山引擎通用 API Key,请点击「查看火山引擎通用 API Key」跳转到火山引擎 IAM 界面。​
​​​
​​​
​
禁用 Viking AI 搜索 API Key​
API Key存在生效/禁用2种状态:​
  • 生效状态:API Key 可正常用于 API 鉴权。API Key 创建后默认生效。​
  • 禁用状态:API Key 禁止鉴权,使用禁用的 API Key 进行鉴权时将返回HTTP状态码401,代表鉴权失败。​
当您检测到某个使用 AI搜索 的服务出现调用量异常,或疑似有API Key泄露风险,您可以登录控制台临时禁用此 API Key。排查无风险后,可再次启用。​
​​​
删除 Viking AI 搜索 API Key​
当您不再有使用某个 API Key 的服务,希望删除此 API Key 时,您可以点击删除按钮删除该 Key。删除时我们会向您进行二次确认,请确认没有线上服务仍在使用该 API Key 后再操作删除,避免导致线上业务异常。​
​​​
在 API 调用中使用 API Key​
*说明​
更多详情,请查看 API鉴权机制说明​
​
在业务服务端调用 Viking AI 搜索接口时,请在请求头中传入 API Key。​
​
Authorization: Bearer <API_KEY>​
​
​
如果 API Key 无效、已禁用、已删除或没有对应权限,接口将返回鉴权失败错误。请检查 API Key 是否正确、是否仍然有效,以及是否使用了正确的服务 endpoint。​
​​
常见问题​
是否必须迁移到火山引擎通用 API Key?​
存量业务可以继续使用历史 AI 搜索 API Key。新业务和新集成建议使用火山引擎通用 API Key,以便使用统一的 API Key 管理能力。​
为什么同时有两类 API Key?​
这是为了同时支持存量兼容。我们建议您高优迁移至火山引擎通用 API Key。​
火山引擎通用 API Key 输入后是否会被保存?​
请以控制台页面实际提示为准。通常情况下,导入流程中的 API Key 仅用于当前调用示例或当前流程。无论页面是否保存,都不建议在共享截图、浏览器插件或日志中暴露完整 API Key。​
最近更新时间:2026.07.15 16:33:47
这个页面对您有帮助吗?
有用
有用
无用
无用