Detalhar Modelo

Retorna as informacoes completas de um modelo, incluindo todas as variaveis detectadas, estatisticas de uso e status.

Endpoint

GET /v1/models/{id}

Headers

Header	Valor
Authorization	Bearer {token}

Parametros de URL

Parametro	Tipo	Obrigatorio	Descricao
id	string (UUID)	Sim	ID do modelo

Exemplo de Requisicao

curl -X GET https://api.tapsign.com.br/v1/models/m1o2d3e4-l5o6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer {token}"

Resposta de Sucesso

Status: 200 OK

{
  "id": "m1o2d3e4-l5o6-7890-abcd-ef1234567890",
  "name": "Contrato de Prestacao de Servicos",
  "status": "ACTIVE",
  "fields": [
    {
      "key": "nome_completo",
      "label": "nome_completo",
      "type": "TEXT",
      "required": true
    },
    {
      "key": "cpf",
      "label": "cpf",
      "type": "TEXT",
      "required": true
    },
    {
      "key": "data_inicio",
      "label": "data_inicio",
      "type": "TEXT",
      "required": true
    },
    {
      "key": "valor_contrato",
      "label": "valor_contrato",
      "type": "TEXT",
      "required": true
    }
  ],
  "variables": [
    "nome_completo",
    "cpf",
    "data_inicio",
    "valor_contrato"
  ],
  "documentCount": 127,
  "createdAt": "2026-03-15T10:00:00Z",
  "updatedAt": "2026-03-29T14:30:00Z"
}

Campos da Resposta

Campo	Tipo	Descricao
id	string (UUID)	ID unico do modelo
name	string	Nome do modelo
status	string	Status: ACTIVE ou INACTIVE
fields	array	Lista completa de campos/variaveis do modelo
fields[].key	string	Identificador da variavel
fields[].label	string	Label de exibicao
fields[].type	string	Tipo do campo
fields[].required	boolean	Se o campo e obrigatorio
variables	string[]	Lista simplificada com os nomes das variaveis
documentCount	number	Total de documentos gerados a partir deste modelo
createdAt	string (ISO 8601)	Data de criacao
updatedAt	string (ISO 8601)	Data da ultima atualizacao

Erros

Codigo	Descricao
404	Modelo nao encontrado
401	Token de autenticacao invalido

Dica

Use o array variables para montar dinamicamente formularios no seu frontend. Cada item corresponde a uma variavel {{...}} que precisa ser preenchida ao criar documentos a partir deste modelo.