Skip to main content

PATCH Atualizar Configuração do Assistente

Atualiza uma configuração do assistente.

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


Endpoint​

PATCH https://api-dev.imagemais.com.br/api/assistant-config/{id}

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
idnumber✅ID do registro

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
namestring❌não vazioNome da configuração
interviewPlanPromptstring❌não vazioPrompt que gera o plano de perguntas
evaluateAnswerPromptstring❌não vazioPrompt que avalia cada resposta
clinicalSummaryPromptstring❌não vazioPrompt que gera o resumo clínico
openaiModelstring❌gpt-4o, gpt-4o-2024-08-06, gpt-4o-2024-11-20, gpt-4o-mini, gpt-4o-mini-2024-07-18, ``Modelo da OpenAI
maxFollowUpsnumber❌inteiro; positivoMáximo de perguntas de follow-up por pergunta
questionCountnumber❌inteiro; positivoQuantidade de perguntas do plano
temperaturenumber❌mín. 0; máx. 2Temperatura da geração (0 = mais determinística)
maxCompletionTokensnumber❌inteiro; positivoLimite de tokens na resposta
topPnumber❌mín. 0; máx. 1Top-p (amostragem por núcleo)
frequencyPenaltynumber❌mín. -2; máx. 2Penalidade de frequência
presencePenaltynumber❌mín. -2; máx. 2Penalidade de presença
seednumber❌inteiroSemente para respostas reproduzíveis
reasoningEffortstring❌minimal, low, medium, highEsforço de raciocínio (modelos de raciocínio)
agentTypestring❌—Chave do tipo de agente a que a configuração se aplica

Requisição​

curl -X 'PATCH' \
'https://api-dev.imagemais.com.br/api/assistant-config/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Exemplo",
"interviewPlanPrompt": "texto",
"evaluateAnswerPrompt": "texto",
"clinicalSummaryPrompt": "texto",
"openaiModel": "gpt-4o",
"maxFollowUps": 1,
"questionCount": 1,
"temperature": 1
}'

Respostas​

200 Sucesso​

{
"id": 2,
"accountId": 1,
"name": "TESTE DOC",
"agentType": null,
"isActive": false,
"openaiModel": "gpt-4o-mini",
"maxFollowUps": 2,
"questionCount": 6,
"temperature": null,
"maxCompletionTokens": null,
"topP": null,
"frequencyPenalty": null,
"presencePenalty": null,
"seed": null,
"reasoningEffort": null,
"interviewPlanPrompt": "Gere o plano de perguntas.",
"evaluateAnswerPrompt": "Avalie a resposta.",
"clinicalSummaryPrompt": "Resuma a entrevista.",
"createdAt": "2026-09-30T18:48:31.848Z",
"updatedAt": "2026-09-30T18:48:32.034Z",
"deletedAt": null
}

400 Requisição inválida​

{
"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​

{
"message": "Configuração de assistente não encontrada",
"error": "Not Found",
"statusCode": 404
}