Skip to main content

POST Responder Pergunta

Registra a resposta do paciente a uma pergunta. A IA avalia a resposta e decide se faz um follow-up, passa para a próxima pergunta ou encerra a entrevista.

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 manage_assistant.


Endpoint​

POST https://api-dev.imagemais.com.br/api/assistant/session/{id}/answer

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
idnumber✅ID do registro

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
questionIdnumber✅inteiro; positivoID da pergunta respondida
transcriptionstring✅—Resposta digitada pelo paciente

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/assistant/session/1/answer' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"questionId": 1,
"transcription": "Texto transcrito de exemplo"
}'

Respostas​

201 Sucesso​

{
"nextAction": "follow_up",
"followUp": {
"id": 21,
"question": "Texto de exemplo."
}
}

400 Requisição inválida​

Retornado quando o corpo ou a query não passam na validação. A lista message traz um item por regra violada, por exemplo:

{
"message": [
"questionId must be a positive number",
"questionId must be an integer number",
"transcription must be longer than or equal to 1 characters",
"transcription must be a string"
],
"error": "Bad Request",
"statusCode": 400
}

Também retornado com a mensagem:

{
"message": "Validation failed (numeric string is expected)",
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

404 Não encontrado​

Mensagens possíveis:

  • Sessão não encontrada
  • Pergunta não encontrada na sessão
{
"message": "Sessão não encontrada",
"error": "Not Found",
"statusCode": 404
}