Sessões de Scribe

Uma sessão de scribe é criada quando um médico realiza uma consulta através da interface da Telepatia. Quando a sessão é finalizada, aqui você consulta o ciclo de vida e os metadados da consulta, e em seguida busca o registro preenchido no endpoint de Documentos de Registro Médico.

Ciclo de vida da sessão

Uma sessão passa por vários estados. Os valores abaixo são retornados literalmente no campo status.

Status	Fase	Descrição
`created`	em andamento	Sessão aberta, gravação ainda não começou
`recording`	em andamento	O médico está gravando ativamente a consulta
`stopped`	em andamento	Gravação encerrada; o áudio está sendo enviado e colocado na fila para processamento
`processing`	em andamento	Pipeline de IA (transcrição + geração do registro) rodando
`completed`	pronto	Pipeline finalizado — os documentos estão disponíveis
`completedWithErrors`	pronto	Pipeline finalizado com erros não fatais — os documentos continuam disponíveis
`reviewed`	pronto	O médico revisou e finalizou o registro
`error`	terminal	Erro fatal no processamento — nenhum documento será produzido
`cancelled`	terminal	O usuário cancelou a sessão
`unknown`	—	Valor padrão quando o estado upstream não é reconhecido

Recuperar uma sessão

Busque uma sessão pelo seu id. O id é o consultationInternalId que você definiu, ou o id da sessão (ss_...) que a API retorna — nesta resposta e como scribeSessionId em cada evento de webhook. Ambos resolvem para a mesma sessão:

# Pelo seu consultationInternalId
curl https://scribe-api.telepatia.ai/v1/scribe-sessions/CONSULT-12345 \
  -H "Authorization: Bearer SUA_CHAVE_API"

# Pelo id da sessão que a API retornou
curl https://scribe-api.telepatia.ai/v1/scribe-sessions/ss_a1b2c3d4e5f6g7h8 \
  -H "Authorization: Bearer SUA_CHAVE_API"

Resposta:

{
  "id": "ss_a1b2c3d4e5f6g7h8",
  "status": "completed",
  "createdAt": "2026-02-20T10:00:00Z",
  "completedAt": "2026-02-20T10:30:00Z",
  "patientName": "John Doe",
  "scribeSessionModality": "IN_PERSON",
  "consultationInternalId": "CONSULT-12345",
  "specialty": "Cardiology"
}

Este endpoint retorna apenas metadados de ciclo de vida e da consulta. O registro preenchido — e seus códigos de diagnóstico ICD — é obtido no endpoint de Documentos de Registro Médico.

Uma sessão criada sem consultationInternalId — por exemplo uma que um clínico gravou diretamente — retorna consultationInternalId: null. Use o id da sessão (ss_...) para buscá-la. Cada endpoint por sessão aceita qualquer um dos dois id.

Enquanto status estiver em andamento (created, recording, stopped, processing), faça polling nesse endpoint até chegar a um estado pronto (completed, completedWithErrors, reviewed) antes de buscar o registro preenchido. error e cancelled são estados terminais — nenhum documento será produzido.

Listar as sessões de um paciente

GET /v1/patients/{patient_id}/scribe-sessions retorna as sessões de scribe de um paciente, da mais recente à mais antiga. O {patient_id} pode ser o id público (sp_...) ou o internalCode que você definiu para a sua instituição. Pagine com page (base 1) e limit (1–50, padrão 20).

curl "https://scribe-api.telepatia.ai/v1/patients/sp_a1b2c3d4e5f6g7h8/scribe-sessions?page=1&limit=20" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Resposta:

{
  "items": [
    {
      "id": "ss_a1b2c3d4e5f6g7h8",
      "status": "completed",
      "createdAt": "2026-02-20T10:00:00Z",
      "completedAt": "2026-02-20T10:30:00Z",
      "patientName": "John Doe",
      "scribeSessionModality": "IN_PERSON",
      "consultationInternalId": "CONSULT-12345",
      "specialty": "Cardiology"
    }
  ],
  "total": 42,
  "page": 1,
  "limit": 20,
  "totalPages": 3,
  "hasMore": true
}

Cada item carrega os mesmos campos de uma sessão individual acima. total e totalPages contam todas as sessões do paciente e estão presentes em todas as páginas. Use id (ss_...) ou consultationInternalId para buscar o registro preenchido de uma sessão no endpoint de Documentos de Registro Médico. Retorna 404 se nenhum paciente com esse id for visível para sua chave.

Recuperar o registro preenchido

Este endpoint retorna apenas o ciclo de vida e os metadados da consulta. O registro preenchido — a saída dos templates da sessão, com todas as seções — é obtido separadamente no endpoint de documentos de registro médico, usando o mesmo consultationInternalId:

curl https://scribe-api.telepatia.ai/v1/scribe-sessions/CONSULT-12345/medical-record-documents \
  -H "Authorization: Bearer SUA_CHAVE_API"

Uma sessão pode produzir mais de um documento (um por purpose — ex.: primary para o registro do médico, rpa para injeção no EMR). Filtre com ?purpose=primary para obter apenas o principal. Veja Documentos de Registro Médico para o formato completo da resposta e a referência de campos.

Primeiros passos

Conceitos principais

Contas e pacientes

Referência

Ciclo de vida da sessão

Recuperar uma sessão

Listar as sessões de um paciente

Recuperar o registro preenchido

​Ciclo de vida da sessão

​Recuperar uma sessão

​Listar as sessões de um paciente

​Recuperar o registro preenchido

Ciclo de vida da sessão

Recuperar uma sessão

Listar as sessões de um paciente

Recuperar o registro preenchido