SuperAPI AI 工具集

inngest-api

部署与运维

查看项目

更新于 10-15 22:38

技能介绍

用途:处理 Inngest REST API v2 的原始 HTTP 调用与 API 参考查询。若任务可通过 npx inngest-cli@latest api 完成,应优先使用 inngest-api-cli,因为 CLI 会处理目标与认证参数及端点命令接线,对智能体更安全。仅在 CLI 未暴露所需端点、用户明确要求 HTTP/curl/fetch/OpenAPI/API 文档,或需先检查请求响应模式时使用原始 REST API v2。

文档查询:API 概览 https://api-docs.inngest.com/,认证 https://api-docs.inngest.com/authentication,LLM 索引 https://api-docs.inngest.com/llms.txt,OpenAPI v2 规范 https://api-docs.inngest.com/api-specs/v2.json。文档页加 .md 可获取 Markdown 版本。端点请求/响应模式见 references/rest-api-v2.md。若 Markdown 页报错或缺少生成细节,改用 OpenAPI 规范。

基础 URL:云端 v2 为 https://api.inngest.com/v2,本地开发服务器 v2 为 http://localhost:8288/api/v2,本地请求前需确认实际端口。

认证:使用 Bearer token。CI、脚本、工具和智能体优先使用 INNGEST_API_KEY;签名密钥主要用于应用与 Inngest 通信,仅在无其他合适凭据时用于 API 请求。API 密钥仅适用于 v2 端点。在非默认生产环境操作时,需包含 X-Inngest-Env 或使用环境作用域 API 密钥。切勿粘贴、打印、提交或记录 API 密钥、事件密钥、签名密钥、webhook URL 或解密后的机密。示例:curl -fsSL -H "Authorization: Bearer $INNGEST_API_KEY" -H "X-Inngest-Env: $INNGEST_ENV" https://api.inngest.com/v2/account

端点发现:以 OpenAPI 规范为准,可用 curl -fsSL https://api-docs.inngest.com/api-specs/v2.json 获取。当前 v2 领域包括 account、environments、keys、webhooks、apps、函数调用、事件-运行查找、函数运行、traces、Insights 及合作伙伴 API。端点覆盖可能变化,写原始请求前先检查规范。仅 API 或受访问限制的端点(如合作伙伴账户端点)需先确认用户具备所需权限。

请求规则:从 OpenAPI 推导方法、路径、查询参数、请求头和请求体;不要虚构未文档化字段;基于响应做决策前先做结构化 JSON 解析;复杂 JSON 使用 body 文件或 here-doc,而非 shell 转义单行;当 page.hasMore 为 true 且需要完整结果时添加分页游标;列表响应中缺失数据视为空列表,除非存在错误。

变更安全:写前先读。除非用户指令已明确,原始 HTTP 变更前需确认目标账户、环境、资源和意图。视为变更或有副作用的操作包括:创建或修补环境、创建 webhook、同步应用、调用函数、创建合作伙伴账户、可能昂贵或嘈杂的大范围 Insights 查询。

输出处理:总结 ID、名称、状态、分页和可操作的错误;对 token 值、webhook URL、敏感负载字段和解密机密做脱敏;除非用户要求,不要粘贴大段原始 trace、完整 OpenAPI 片段或完整响应体。若认证失败,先确认环境中存在凭据,再请用户提供或轮换 INNGEST_API_KEY,且不要将其粘贴到聊天中。