Generate document from template

POST

/v1/cards/{cardId}/templates/{templateId}/generate

Generates the document (a filled-in .docx file) from a template and the data of a specific card.

The request body follows its own field-naming convention: inside fields.clients[], each field is identified by a key made up of the parent group name and the child field name, in the format parentGroup.childField (for example, fiadores.nome) — never by the field's identifier (id), which is rejected by the API. The same applies to fields.generalSections[]: each field uses key, title, type and value, without id. In addition, each item in clients[] requires name and index besides clientId and fields, and each item in generalSections[] requires title and index besides section and fields.

We recommend first querying the card's fields endpoint (GET .../templates/{templateId}/fields) to get the exact structure to fill in before assembling this request body.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Document generated

application/json

Illustrative example of the response, reflecting the document generated from the template.

Bodyapplication/json

🟠400Invalid payload

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/cards//templates//generate' \
--header 'Content-Type: application/json' \
--data '{
    "fileName": "string",
    "fields": {
        "clients": [
            {
                "clientId": "string",
                "name": "string",
                "index": 0,
                "fields": [
                    {
                        "key": "string",
                        "title": "string",
                        "type": "string",
                        "value": null
                    }
                ]
            }
        ],
        "generalSections": [
            {
                "section": "string",
                "title": "string",
                "index": 0,
                "fields": [
                    {
                        "key": "string",
                        "title": "string",
                        "required": true,
                        "type": "string",
                        "value": null
                    }
                ]
            }
        ],
        "general": [
            "string"
        ],
        "opinion": null,
        "images": [
            "string"
        ]
    }
}'

Response Example

200 - Exemplo 1

{
    "id": "string",
    "fileName": "string",
    "fileDownloadUrl": "string"
}

Modificado em 2026-07-28 20:38:32

Página anterior

Get fields for document generation

Próxima página

Get template by ID