用途:通过 n8n 的 REST API 以编程方式控制 n8n,实现工作流、执行记录、凭据和标签的自动化管理。
认证与基础地址:在 Settings → API → Create API Key 创建 API Key,密钥仅显示一次需安全保存。请求头使用 X-N8N-API-KEY。自托管基础地址为 http://localhost:5678/api/v1,云端为 https://your-instance.n8n.cloud/api/v1。
主要能力:工作流方面支持列出、按 ID 获取、创建、更新、删除,以及通过 PATCH 激活或停用({"active": true})。执行方面支持执行工作流(POST /api/v1/workflows/{id}/execute,可带输入数据)、列出执行(支持 workflowId、status、limit、cursor 查询参数)、获取执行详情、删除与重试。凭据方面支持列出、创建、获取凭据类型 schema、删除。标签方面支持列出、创建、更新,并可通过 PATCH 工作流关联标签。用户管理(Enterprise)支持列出、创建、更新角色。
使用方式:可用 cURL、JavaScript/Node.js、Python 调用。示例:curl -X GET "http://localhost:5678/api/v1/workflows" -H "X-N8N-API-KEY: your-api-key"。常见集成模式包括 CI/CD(如 GitHub Actions 部署工作流 JSON)、Webhook 中继和监控集成。
限制与错误处理:常见错误码包括 401(检查 API Key)、403(检查权限)、404(检查 ID)、422(检查请求体)、500(检查 n8n 日志)。可实现重试逻辑。用户管理功能仅限 Enterprise。具体收费、价格与平台支持范围暂未提供。