用途
该技能用于回答关于火山引擎 API 规范的问题。它通过实时调用火山引擎 API Explorer 的公开接口,获取权威且持续更新的 API 元数据,而非依赖模型记忆,从而降低因 API 变更导致信息过时的风险。
主要能力
- 查找 API:当用户用自然语言描述需求但不知道具体接口名时,可通过关键词搜索或逐级浏览服务/版本/API 列表来定位目标接口。
- 查询参数:获取请求方法(GET/POST)、必填参数、参数类型、枚举值、默认值、示例值,以及嵌套参数结构(如数组参数使用 ParamName.N 命名,嵌套对象使用 Parent.Child 命名,POST 请求中通过 $ref 递归展开)。
- 参数依赖规则:识别条件必填、互斥、值约束、前置依赖等规则,帮助用户避免配置错误。
- 分页机制:识别 API 使用的分页模式(基于令牌的 MaxResults + NextToken,或基于偏移的 PageSize + PageNumber / Offset + Limit),并说明默认值与上限。
- 响应结构:列出关键返回字段、类型、描述、枚举字段的所有可能取值以及嵌套对象结构,并可附带官方请求/响应示例(来自 x-demo)。
- 错误码诊断:针对用户提供的错误码或 API 名称,查询对应 Swagger 中的错误码定义,结合中文描述与英文 message 给出含义、触发条件、排查步骤和解决建议;对于限流类错误建议重试策略。
- 浏览服务:按 ApiGroup 组织展示某服务下的 API 列表,包含 Action 名、中文名与一句话描述。
- API 对比:分别查询两个 API 的详情,对比功能用途、适用场景与参数差异,并给出使用建议。
使用方式
技能定义了渐进式查询流程:
- 先判断用户意图(找 API / 查参数 / 查响应 / 查参数依赖 / 查错误码 / 浏览服务 / 对比 API)。
- 根据已知信息选择查询路径:已知 Action 名可直接查询 API 详情(api-swagger 接口);已知服务名可先查版本列表再查 API 列表;仅有自然语言描述时优先使用搜索接口(api/common/search/all,Channel=api)。
- 解析 Swagger/OpenAPI 规范,提取 HTTP 方法、请求参数、响应结构、错误码与官方示例。
- 按问题类型组织答案,以用户问题为中心,突出必填参数、枚举值、条件规则与取值范围。
错误码查询时,若用户仅提供错误码,技能会先询问触发该错误的 API 名称,因为同一错误码在不同 API 中含义可能不同;若无法提供,则使用错误码搜索接口(Channel=error_code)并按上下文过滤结果。
适用场景
- 开发者在调用火山引擎 API 前确认参数要求与取值。
- 排查调用失败原因,理解错误码含义。
- 了解某服务的 API 能力范围。
- 在多个相似 API 之间做选择。
限制
- 依赖网络访问火山引擎 API Explorer 接口;若发生网络错误,需告知用户并建议稍后重试。
- 若用户描述模糊,技能会列出可能选项并请求确认,而非猜测。
- 该技能聚焦 API 规范查询;若用户需要可运行的 SDK 代码或 CLI 操作,资料中建议转向 volcengine-sdk-generator 或 volcengine-cli 技能。
- 资料未提供该技能的安装命令、收费模式、独立运行平台或性能指标,暂未提供。