n8n-core-api 是一份针对 n8n 公共 REST API 的参考文档，旨在帮助开发者以编程方式与 n8n 集成、通过 API 管理工作流，或构建 n8n 管理工具。文档内容结构清晰，覆盖 API 基础、资源端点、关键操作模式、配置与决策指南。
用途与主要能力 该文档聚焦于 n8n 公共 REST API 的调用方式与最佳实践。它提供了 API 基础信息，包括基础 URL 格式（<N8N_HOST>:<N8N_PORT>/<N8N_PATH>/api/v1/）、认证方式（X-N8N-API-KEY 请求头）、内容类型（application/json）、分页机制（游标分页，最大页大小 250，默认 100）以及 API 调试界面（<base-url>/api/v1/docs，基于 Scalar UI）。文档还列出了资源端点概览，涵盖工作流、执行、凭证、用户、标签、变量、项目、审计和源码控制等资源，并标注了各自的 CRUD 操作和特殊操作（如激活/停用工作流、重试/停止执行、转移凭证等）。
关键操作模式 文档通过多个模式示例展示了常见任务的实现方式，例如：列出活动工作流、创建并激活工作流（需分两步调用）、重试失败执行、在工作流之间转移项目、分页遍历所有执行记录。每个模式都附带了 curl 命令示例和注意事项，如“创建后需单独调用激活端点”、“重试前需确认执行状态为 error 或 crashed”。
认证与分页 认证部分说明了 API 密钥的创建步骤（在 n8n UI 的 Settings > n8n API 中创建），并强调密钥仅显示一次、需通过环境变量或密钥管理系统存储。企业版还支持基于作用域（scope）的权限控制，作用域格式为 resource:action（如 workflow:list、execution:retry）。分页部分详细解释了游标分页的工作机制：首次请求指定 limit，响应包含 data 数组和 nextCursor 字符串，后续请求携带 cursor 参数，直到 nextCursor 为 null 或缺失表示最后一页。文档反复警告禁止使用偏移分页，并提供了分页遍历的 shell 脚本示例。
配置与决策指南 文档列出了相关环境变量，如 N8N_PUBLIC_API_DISABLED（禁用公共 API）、N8N_PUBLIC_API_ENDPOINT（路径前缀）、N8N_PUBLIC_API_SWAGGERUI_DISABLED（禁用 Scalar UI）。决策树部分帮助用户根据需求选择端点（管理工作流、检查执行、管理凭证、组织资源）以及判断使用 API 还是 CLI（远程/Docker 环境用 API，本地一次性管理任务可用 CLI）。
适用场景 该文档适用于需要以编程方式管理 n8n 工作流、执行记录、凭证等资源的开发者，以及构建 n8n 管理工具或自动化脚本的团队。对于使用 Docker 或远程 n8n 实例的用户，REST API 是唯一的管理方式。
限制与注意事项 文档明确指出了多项限制：公共 REST API 需要付费计划（免费试用不可用）；API 密钥必须通过安全方式存储，禁止硬编码；分页结果上限为 250，超出会被静默截断；禁止删除运行中的执行（需先停止）；企业版才支持作用域权限。此外，文档中的示例命令需替换 <BASE_URL>、<your-api-key> 等占位符后才能实际使用。
参考资源 文档末尾提供了参考文件链接（references/methods.md、references/examples.md、references/anti-patterns.md）以及官方文档链接（n8n API 文档、认证指南、分页文档、环境变量参考），便于进一步查阅。