Skip to main content

POST Extrair Campos do Texto

Pede à IA que transforme um texto livre (normalmente a transcrição do relato) em um objeto JSON com os campos desejados. A rota não grava nada na pré-consulta — o cliente usa o resultado para preencher o formulário e depois chama Atualizar Pré-consulta.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão update_preconsultations.

O formato é definido pelas instruções

A resposta é o JSON gerado pela IA a partir de message e instructions — as chaves e os tipos dependem do que for pedido nas instruções e podem variar (ex.: números em vez de texto). Valide o resultado antes de salvar.


Endpoint​

POST https://api-dev.imagemais.com.br/api/pre-consultations/{id}/extract

Path Parameter​

CampoTipoObrigatórioDescrição
idnumber✅ID da pré-consulta

Corpo da Requisição​

CampoTipoObrigatórioDescrição
messagestring✅Texto de origem (ex.: transcrição do relato)
instructionsstring❌Instruções para a IA: quais campos extrair e em que formato
modelstring❌Aceito pela validação (lista de modelos permitidos), mas não é repassado por esta rota
qualitystring❌default ou reasoning. Aceito pela validação, mas não é repassado por esta rota

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/pre-consultations/29/extract' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"message": "Paciente relata dor de cabeça há 3 dias. PA 130/85, FC 80, temperatura 37,2, peso 72 kg, altura 1,75 m, glicemia 95.",
"instructions": "Extraia os sinais vitais e o motivo da consulta em JSON com as chaves bloodPressure, heartRate, temperature, weight, height, glucose e consultationReason."
}'

Respostas​

201 Sucesso​

{
"bloodPressure": "130/85",
"heartRate": 80,
"temperature": 37.2,
"weight": 72,
"height": 1.75,
"glucose": 95,
"consultationReason": "dor de cabeça há 3 dias"
}

400 Bad Request​

Retornado quando message não é enviado.

{
"message": [
"message must be a string",
"message should not be empty"
],
"error": "Bad Request",
"statusCode": 400
}

404 Pré-consulta não encontrada​

Retornado quando o id não existe, foi excluído ou pertence a outra conta.

{
"message": "Pré-consulta não encontrada",
"error": "Not Found",
"statusCode": 404
}