SuperAPI AI 工具集

volcengine-api

编程与开发

查看项目

更新于 10-15 17:30

技能介绍

用途:回答用户关于火山引擎 API 的问题,数据来自 API Explorer 在线接口,避免依赖记忆中的过时信息。触发场景包括询问 API 参数、错误码、请求结构等。

主要能力:查找 API;查询请求参数(类型、必填、枚举、默认值、示例);查询返回结构与枚举状态值;解析参数依赖(条件必填、互斥、取值约束、前置条件);说明分页方式(MaxResults+NextToken 或 PageSize+PageNumber);解释错误码含义与排查建议;浏览服务下的 API 列表;对比两个 API 的差异。

使用方式:按需逐级查询。服务列表 GET https://api.volcengine.com/api/common/explorer/services;版本列表 GET https://api.volcengine.com/api/common/explorer/versions?ServiceCode={ServiceCode};API 列表 GET https://api.volcengine.com/api/common/explorer/apis?ServiceCode={ServiceCode}&Version={Version}&APIVersion={Version};API 详情(Swagger/OpenAPI)GET https://api.volcengine.com/api/common/explorer/api-swagger?ServiceCode={ServiceCode}&Version={Version}&APIVersion={Version}&ActionName={ActionName};关键词搜索 GET https://api.volcengine.com/api/common/search/all?Query={keyword}&Channel=api;错误码搜索 GET https://api.volcengine.com/api/common/search/all?Query={error_code}&Channel=error_code。已知 API 名可直接查详情;仅知服务名可按版本、列表逐级查或并行搜索;仅有自然语言描述时优先搜索。

适用场景:资源操作 API 检索、参数与枚举确认、返回字段核对、分页实现、错误码定位、服务能力概览、API 选型对比。

限制:同名错误码在不同 API 下含义可能不同,建议结合具体 API 详情确认;应答语言跟随用户;描述含糊时先列选项确认;若需可运行 SDK 代码应转 volcengine-sdk-generator,若需 CLI 操作应转 volcengine-cli;网络错误时应提示用户稍后重试。以上资料未提供收费、价格及平台支持等具体信息。