Modelos
Modelos de fluxo de trabalho
Ao criar um novo fluxo de trabalho, você pode escolher se deseja começar com um fluxo vazio ou usar um modelo existente.
Os modelos oferecem:
- Ajuda para começar: o n8n pode já ter um modelo que faz exatamente o que você precisa.
- Exemplos do que é possível construir.
- Melhores práticas para criar seus próprios fluxos de trabalho.
Acessar modelos
Selecione o ícone
Templates para visualizar a biblioteca de modelos.
Se você usar a biblioteca de modelos do n8n, você será redirecionado para navegar pelos Fluxos de trabalho no site do n8n. Se estiver usando uma biblioteca personalizada fornecida pela sua organização, você poderá pesquisar e navegar pelos modelos diretamente no aplicativo.
Adicione seu fluxo de trabalho à biblioteca do n8n
O n8n está desenvolvendo um programa para criadores e um marketplace de modelos. Este é um projeto em andamento, e os detalhes podem mudar.
n8n autohospedado: Use sua própria biblioteca
Nas variáveis de ambiente, defina N8N_TEMPLATES_HOST como a URL base da sua API.
Endpoints
Sua API deve fornecer os mesmos endpoints e estrutura de dados utilizados pelo n8n.
Os endpoints são:
| Método | Caminho | Finalidade |
|---|---|---|
| GET | /templates/workflows/ | Buscar metadados dos modelos para visualização/navegação |
| GET | /workflows/templates/ | Buscar os dados do fluxo de trabalho para importar na tela |
| GET | /templates/search | Pesquisar por modelos de fluxo de trabalho |
| GET | /templates/collections/ | Obter uma coleção específica de modelos |
| GET | /templates/collections | Listar todas as coleções de modelos |
| GET | /templates/categories | Listar todas as categorias de modelos |
| GET | /health | Endpoint de health check |
Importante: Dois formatos diferentes de resposta são necessários
Os dois endpoints de fluxo de trabalho exigem formatos de resposta diferentes:
/templates/workflows/: Retorna o próprio modelo, incluindo o fluxo de trabalho na chaveworkflow/workflows/templates/: Retorna apenas o fluxo de trabalho contido no modelo
Veja os esquemas abaixo para mais detalhes.
Parâmetros de consulta
O endpoint /templates/search aceita os seguintes parâmetros de consulta:
| Parâmetro | Tipo | Descrição |
|---|---|---|
page | inteiro | A página de resultados a ser retornada |
rows | inteiro | O número máximo de resultados por página |
category | lista separada por vírgulas de strings (categorias) | As categorias nas quais buscar |
search | string | A consulta de pesquisa |
O endpoint /templates/collections aceita os seguintes parâmetros de consulta:
| Parâmetro | Tipo | Descrição |
|---|---|---|
category | lista separada por vírgulas de strings (categorias) | As categorias nas quais buscar |
search | string | A consulta de pesquisa |
Esquemas
A principal diferença entre os dois endpoints de fluxo de trabalho:
GET /templates/workflows/retorna um objeto com metadados do modelo e o fluxo de trabalho aninhado na chaveworkflow:
{
"id": 123,
"name": "Exemplo",
"workflow": {
"nodes": [...],
"connections": {...}
}
}
GET /workflows/templates/retorna apenas o conteúdo do fluxo de trabalho, sem metadados:
{
"nodes": [...],
"connections": {...}
}
Esquemas detalhados dos objetos de resposta:
Mostrar esquema de dados do item workflow
Usado pelo endpoint /templates/workflows/ (envolvido na chave workflow).
Este esquema descreve os metadados do modelo exibidos nas interfaces de busca e navegação. Ele inclui uma propriedade aninhada chamada workflow, que contém a definição real do fluxo de trabalho que pode ser importado.
Esquema de dados do item workflow
{
"type": "object",
"properties": {
"id": { "type": "integer" },
"name": { "type": "string" },
"totalViews": { "type": "integer" },
"price": { "type": ["number", "null"] },
"purchaseUrl": { "type": ["string", "null"] },
"recentViews": { "type": "integer" },
"createdAt": { "type": "string", "format": "date-time" },
"user": {
"type": "object",
"properties": {
"username": { "type": "string" },
"verified": { "type": "boolean" }
},
"required": ["username", "verified"]
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"icon": { "type": "string" },
"name": { "type": "string" },
"codex": {
"type": "object",
"properties": {
"resources": {
"type": "object",
"properties": {
"primaryDocumentation": {
"type": "object",
"properties": {
"url": { "type": "string" }
},
"required": ["url"]
}
}
},
"categories": {
"type": "array",
"items": { "type": "string" }
},
"nodeVersion": { "type": "integer" },
"codexVersion": { "type": "integer" }
},
"required": ["categories"]
},
"group": { "type": "array", "items": { "type": "string" } },
"defaults": {
"type": "object",
"properties": {
"name": { "type": "string" },
"color": { "type": "string" }
},
"required": ["name"]
},
"iconData": {
"type": "object",
"properties": {
"type": { "type": "string" },
"fileBuffer": { "type": "string" }
},
"required": ["type"]
},
"displayName": { "type": "string" },
"typeVersion": { "type": "integer" },
"nodeCategories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer" },
"name": { "type": "string" }
},
"required": ["id", "name"]
}
}
},
"required": [
"id",
"icon",
"name",
"codex",
"group",
"defaults",
"iconData",
"displayName",
"typeVersion"
]
}
},
"description": { "type": "string" },
"image": {
"type": "object",
"properties": {
"url": { "type": "string" }
}
},
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer" },
"name": { "type": "string" }
}
}
},
"workflowInfo": {
"type": "object",
"properties": {
"nodeTypes": { "type": "array", "items": { "type": "string" } }
}
},
"workflow": {
"type": "object",
"properties": {
"nodes": { "type": "array" },
"connections": { "type": "object" },
"settings": { "type": "object" },
"pinData": { "type": ["object", "null"] }
},
"required": ["nodes", "connections"]
}
},
"required": [
"id",
"name",
"totalViews",
"createdAt",
"user",
"nodes",
"workflow"
]
}
Mostrar esquema de dados do item category
Esquema de dados do item category
{
"type": "object",
"properties": {
"id": { "type": "integer" },
"name": { "type": "string" }
},
"required": ["id", "name"]
}
Mostrar esquema de dados do item collection
Esquema de dados do item collection
{
"type": "object",
"properties": {
"id": { "type": "integer" },
"rank": { "type": "integer" },
"name": { "type": "string" },
"totalViews": { "type": "integer" },
"createdAt": { "type": "string", "format": "date-time" },
"workflows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "integer" }
},
"required": ["id"]
}
},
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"name": { "type": "string" }
}
}
}
},
"required": [
"id",
"rank",
"name",
"totalViews",
"createdAt",
"workflows",
"nodes"
]
}
Você também pode explorar interativamente os endpoints da API do n8n:
- https://api.n8n.io/templates/categories
- https://api.n8n.io/templates/collections
- https://api.n8n.io/templates/search
- https://api.n8n.io/health
Se precisar de mais ajuda, entre em contato conosco.