Criar template de documento

Cria um novo template de documento. A criação de um template é um processo composto por múltiplas etapas, e este endpoint executa apenas a primeira delas: registra os metadados do template (nome, processador, escopo, seções e a definição inicial dos campos) e retorna uma URL assinada e temporária (fileUploadUrl) para o envio do arquivo .docx correspondente.

Os campos (fields) enviados nesta chamada não são persistidos como configuração definitiva do template — a etapa seguinte, de definição de campos, é sempre necessária para que os campos realmente passem a valer. Após o upload do arquivo e a definição dos campos, o template ainda precisa ser ativado para ficar disponível para geração de documentos.

O campo templateProcessor aceita apenas o valor docx-templates. O campo scope corresponde ao identificador do flow ao qual o template pertence — um template é sempre específico de um flow; reutilizar o identificador de um template criado em outro flow retorna erro de recurso não encontrado. O campo application é opcional e assume agflow como padrão quando omitido. O campo description é obrigatório — quando não houver uma descrição específica, recomenda-se reenviar o mesmo valor de name.

Cada campo declarado em fields deve ter uma chave (key) idêntica à variável {{chave}} usada no arquivo .docx — a comparação é sensível a maiúsculas/minúsculas e não deve ser traduzida. O formato do dado de origem de cada campo varia conforme sua procedência: campos vindos do formulário inicial do flow usam path fixo start-form e reference igual ao identificador do campo; campos vindos de uma fase usam path no formato phase-field.<identificador-da-fase> e reference no formato <identificador-da-fase>:<identificador-do-campo>; campos vindos do parecer técnico usam path fixo opinion-field e reference igual ao identificador do campo; já campos nativos — como dados básicos do cliente, aprovações ou resultado do motor de crédito — usam apenas um path fixo (por exemplo basic-data.name ou credit-engine.score) e não precisam de reference. Um path não reconhecido pela API não gera erro, mas resulta em campo vazio no documento gerado.

application/json

Exemplo ilustrativo da resposta. fileUploadUrl é uma URL assinada e temporária para envio direto do arquivo .docx (fora da API do AgFlow).

Bodyapplication/json

curl --location '/templates' \ --header 'Content-Type: application/json' \ --data '{ "templateProcessor": "docx-templates", "application": "agflow", "scope": "string", "name": "string", "description": "string", "sections": [ { "section": "string", "title": "string", "index": 0 } ], "fields": [ { "key": "string", "title": "string", "type": "default", "path": "string", "reference": "string", "required": true, "uiComponent": "short-text", "section": "string", "options": [ "string" ], "children": [ {} ] } ] }'

Criar template de documento

Requisição

Respostas