SuperAPI AI 工具集

n8n-api

智能体与模型

查看项目

更新于 10-15 17:26

技能介绍

用途:在已知 n8n 实例地址和 API key 的前提下,通过公开 /api/v1 接口进行只读检查或受控写入操作。

必要输入:实例基础 URL(含路径前缀、无尾斜杠)、经环境变量或密钥管理器提供的 API key、明确的操作与目标资源;任何变更(发布、重试、停止、删除、打包、设置、源码控制等)需用户明确授权。不要把 key 粘贴进聊天,也不要打印、记录或持久化。示例使用 N8N_BASE_URL 与 N8N_API_KEY。

主要能力:先做能力发现,而非套用固定端点列表。可调用:curl --silent --show-error --fail-with-body -H "Accept: application/json" -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_BASE_URL/api/v1/discover?resource=workflow&include=schemas",返回当前 key 可见的 scopes、资源、操作、端点路径与 specUrl。自托管实例内置 Swagger UI 在 /api/v1/docs;托管 playground 会代理调用,切勿填入生产 key。旧实例无 discover 时用其 /api/v1/docs 或官方端点参考,不要回退到未文档化的 /rest/* 路由。

用法要点:先读后写,写前获取当前状态并核对 ID、项目、名称与版本;从发现的请求 schema 构建最小合法 body,不要原样回传 GET 结果;凭据字段用 /credentials/schema/{credentialTypeName} 获取。key 仅放在 X-N8N-API-KEY 头,JSON 请求加 Content-Type: application/json。列表使用游标分页,默认 100、最大 250,跟随 nextCursor 至缺失/为空,不要只报第一页。写入后回读或过滤列表验证结果,部分成功要明确说明;2xx 只代表请求被接受。

限制:公开 API 不提供通用的“运行任意 workflow”操作;/activate 与 /deactivate 已弃用,改用 publish/unpublish;/webhook-test 仅在编辑器监听时有效。能力因托管方案、许可证、角色和配置而异,403 不等于端点不存在。错误码 400/401/403/404/409/429 分别按 schema、key、权限、路径或冲突、限流处理,对非幂等请求不要盲目重试。