Skip to content

工作流模板#

在创建新工作流时，您可以选择是从空工作流开始，还是使用现有模板。

模板提供：

  • 帮助入门：n8n 可能已经有一个模板可以满足您的需求。
  • 您可以构建的示例
  • 创建自己工作流的最佳实践

访问模板#

选择 查看模板图标 模板查看模板库。

如果您使用 n8n 的模板库，这会带您浏览 n8n 网站上的工作流。如果您使用组织提供的自定义库，您将能够在应用程序内搜索和浏览模板。

将您的工作流添加到 n8n 库#

您可以将您的工作流提交到 n8n 的模板库。

n8n 正在开发创作者计划，并开发模板市场。这是一个正在进行的项目，详细信息可能会发生变化。

请参考 n8n Creator hub 了解如何提交模板和成为创作者的信息。

自托管 n8n：使用您自己的库#

在您的环境变量中，将 N8N_TEMPLATES_HOST 设置为您的 API 的基础 URL。

端点#

您的 API 必须提供与 n8n 相同的端点和数据结构。

端点包括：

方法 路径 用途
GET /templates/workflows/<id> 获取用于预览/浏览的模板元数据
GET /workflows/templates/<id> 获取可导入到画布的工作流数据
GET /templates/search 搜索工作流模板
GET /templates/collections/<id> 获取指定模板集合
GET /templates/collections 列出所有模板集合
GET /templates/categories 列出所有模板分类
GET /health 健康检查端点

关键：需要两种不同的响应格式

两个工作流端点要求 不同的响应格式：

  • /templates/workflows/{id}：返回模板本身，工作流位于 workflow 字段内
  • /workflows/templates/{id}：直接返回模板中包含的工作流

请参阅下方 Schemas 了解详情。

查询参数#

/templates/search 端点接受以下查询参数：

参数 类型 描述
page 整数 要返回的结果页面
rows 整数 每页返回的最大结果数
category 逗号分隔的字符串列表（类别） 要搜索的类别
search 字符串 搜索查询

/templates/collections 端点接受以下查询参数：

参数 类型 描述
category 逗号分隔的字符串列表（类别） 要搜索的类别
search 字符串 搜索查询

Schemas 架构#

两个工作流端点的关键区别如下：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// GET /templates/workflows/{id} 返回（包装后）:
{
  "workflow": {
    "id": 123,
    "name": "...",
    "totalViews": 1000,
    // ... 完整结构见下方 workflow item schema
    "workflow": {    // 实际可导入的工作流定义
      "nodes": [...],
      "connections": {}
    }
  }
}

// GET /workflows/templates/{id} 返回（扁平）:
{
  "id": 123,
  "name": "...",
  "workflow": {      // 实际可导入的工作流定义
    "nodes": [...],
    "connections": {}
  }
}

以下为响应对象的详细结构：

显示 workflow 项目数据架构

用于 /templates/workflows/{id} 端点（外层由 workflow 字段包装）。

该结构用于模板搜索/浏览界面展示模板元数据，其中包含嵌套的 workflow 字段，该字段内是实际可导入的工作流定义。

工作流项目数据架构
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Generated schema for Root",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "totalViews": {
      "type": "number"
    },
    "price": {},
    "purchaseUrl": {},
    "recentViews": {
      "type": "number"
    },
    "createdAt": {
      "type": "string"
    },
    "user": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        },
        "verified": {
          "type": "boolean"
        }
      },
      "required": [
        "username",
        "verified"
      ]
    },
    "nodes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "icon": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "codex": {
            "type": "object",
            "properties": {
              "data": {
                "type": "object",
                "properties": {
                  "details": {
                    "type": "string"
                  },
                  "resources": {
                    "type": "object",
                    "properties": {
                      "generic": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "url": {
                              "type": "string"
                            },
                            "icon": {
                              "type": "string"
                            },
                            "label": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "url",
                            "label"
                          ]
                        }
                      },
                      "primaryDocumentation": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "url": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "url"
                          ]
                        }
                      }
                    },
                    "required": [
                      "primaryDocumentation"
                    ]
                  },
                  "categories": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "nodeVersion": {
                    "type": "string"
                  },
                  "codexVersion": {
                    "type": "string"
                  }
                },
                "required": [
                  "categories"
                ]
              }
            }
          },
          "group": {
            "type": "string"
          },
          "defaults": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "color": {
                "type": "string"
              }
            },
            "required": [
              "name"
            ]
          },
          "iconData": {
            "type": "object",
            "properties": {
              "icon": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "fileBuffer": {
                "type": "string"
              }
            },
            "required": [
              "type"
            ]
          },
          "displayName": {
            "type": "string"
          },
          "typeVersion": {
            "type": "number"
          },
          "nodeCategories": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "name"
              ]
            }
          }
        },
        "required": [
          "id",
          "icon",
          "name",
          "codex",
          "group",
          "defaults",
          "iconData",
          "displayName",
          "typeVersion"
        ]
      }
    },
    "description": {
      "type": "string"
    },
    "image": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "url": {
            "type": "string"
          }
        }
      }
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          }
        }
      }
    },
    "workflowInfo": {
      "type": "object",
      "properties": {
        "nodeCount": {
          "type": "number"
        },
        "nodeTypes": {
          "type": "object"
        }
      }
    },
    "workflow": {
      "type": "object",
      "properties": {
        "nodes": {
          "type": "array"
        },
        "connections": {
          "type": "object"
        },
        "settings": {
          "type": "object"
        },
        "pinData": {
          "type": "object"
        }
      },
      "required": [
        "nodes",
        "connections"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "totalViews",
    "createdAt",
    "user",
    "nodes",
    "workflow"
  ]
}
显示 category 项目数据架构
类别项目数据架构
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "name"
  ]
}
显示 collection 项目数据架构
集合项目数据架构
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "rank": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "totalViews": {},
    "createdAt": {
      "type": "string"
    },
    "workflows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          }
        },
        "required": [
          "id"
        ]
      }
    },
    "nodes": {
      "type": "array",
      "items": {}
    }
  },
  "required": [
    "id",
    "rank",
    "name",
    "totalViews",
    "createdAt",
    "workflows",
    "nodes"
  ]
}

您还可以交互式地探索 n8n 的 API 端点：

https://api.n8n.io/templates/categories https://api.n8n.io/templates/collections https://api.n8n.io/templates/search https://api.n8n.io/health

您可以联系我们获取更多支持。