/v1/conversations/{id}/messages/{messageId}/derived
Gravar o texto derivado da mídia de UMA mensagem recebida (somente a Lívia / fluxo de mídia)
Somente token de serviço do agente knowledge com a permissão exclusiva messages:derived. Nenhuma pessoa (nem o administrador), outro agente ou equipe da plataforma grava.
Grava na mensagem recebida com mídia (media presente) o texto que o fluxo de mídia entendeu: kind = transcription (áudio/vídeo) ou image_text (imagem/figurinha/documento). O texto original da mensagem não muda.
Status: available exige text (1 a 8000 caracteres). withheld (conteúdo retido pela política: exame, receita, foto clínica, comprovante, bloqueio do guardrail) e failed não aceitam texto (422); o painel mostra "Conteúdo não exibido" / "Não foi possível transcrever".
Idempotência: primeira gravação → 201; repetir o mesmo conteúdo (kind, status e texto) → 200 com Idempotent-Replayed: true, sem alterar derivedAt nem auditar de novo; conteúdo diferente depois de gravado → 409 derived_already_set. Mensagem sem mídia, enviada ou de sistema → 409 message_has_no_media. Tipo de derivado incompatível com a mídia → 422 derived_kind_mismatch. Sessão de Agent Preview → 403 preview_record_only.
Auditoria: só ids, kind, status e o tamanho do texto. O texto nunca vai para auditoria, log nem evento.
messages:derivedAutenticação
Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar
Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>Parâmetros
Parâmetros de caminho
idstringObrigatórioEntre 1 e 64 caracteres · Padrão (regex):
^[A-Za-z0-9._-]+$messageIdstringObrigatórioEntre 1 e 64 caracteres · Padrão (regex):
^[A-Za-z0-9._-]+$
Cabeçalhos
X-Clinic-IdstringOpcionalClínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex):
^[A-Za-z0-9._-]{1,64}$
Corpo da requisição
application/json · obrigatório
kindstringObrigatórioValores:
transcription,image_textstatusstringObrigatórioValores:
available,withheld,failedtextstring | nullOpcionalObrigatório com
available; proibido comwithheldefailed. · Até 8000 caracteres
Exemplo de requisição
Gerado do contrato. Troque os marcadores entre < > pelos seus valores.
const res = await fetch("https://myclinc.leadpoint.com.br/v1/conversations/<id>/messages/<messageId>/derived", { method: "PUT", headers: { Authorization: "Bearer <TOKEN>", "X-Clinic-Id": "<clinic_id>", "X-Agent-Key": "<agent_key>", "Content-Type": "application/json", }, body: JSON.stringify({ "kind": "transcription", "status": "available", "text": "<text>" }),})if (!res.ok) { const { error } = await res.json() throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()Resposta
{ "data": { "id": "<id>", "from": "patient", "text": "<text>", "sentAt": "2026-09-18T14:00:00.000Z", "agent": { "key": "<key>", "name": "<name>", "image": "<image>" }, "authorName": "<authorName>", "senderRole": "owner", "read": true, "delivery": "enviando", "media": { "type": "audio", "mimeType": "<mimeType>", "durationSeconds": 0 }, "derived": { "kind": "transcription", "status": "available", "text": "<text>", "derivedAt": "2026-09-18T14:00:00.000Z" } }}{ "data": { "id": "<id>", "from": "patient", "text": "<text>", "sentAt": "2026-09-18T14:00:00.000Z", "agent": { "key": "<key>", "name": "<name>", "image": "<image>" }, "authorName": "<authorName>", "senderRole": "owner", "read": true, "delivery": "enviando", "media": { "type": "audio", "mimeType": "<mimeType>", "durationSeconds": 0 }, "derived": { "kind": "transcription", "status": "available", "text": "<text>", "derivedAt": "2026-09-18T14:00:00.000Z" } }}Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.
Códigos de erro
Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.
Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).
Unauthorized — Token ausente, inválido ou expirado.
Forbidden — Autenticado, mas sem permissão (perfil ou clínica).
Not Found — Recurso não encontrado na clínica ativa.
Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).
Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).
Too Many Requests — Limite de requisições excedido (veja Retry-After).
Internal Server Error — Erro interno (sem detalhes expostos).
Service Unavailable — Banco de dados indisponível ou não configurado.
Limites
Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites