Skip to main content
A Scribe API permite que sistemas de saúde se integrem com a plataforma Telepatia. Use-a para definir o contexto da consulta, abrir o scribe para o médico e buscar os resultados da sessão após um atendimento.

​
Fluxo de integração

  1. Escolher (ou construir) um Smart Template — Defina quais seções a Telepatia gera usando Prompts Telepatia curados. Reutilize entre consultas.
  2. Definir contexto da consulta — Preencher dados do paciente e anexar o Smart Template (JSON inline ou por medicalRecordConfigurationId).
  3. Gerar um link de login — Criar um código de verificação pra abrir o scribe, passando o consultationInternalId.
  4. Realizar a sessão — O médico usa o scribe pra gravar e finalizar a consulta.
  5. Buscar resultados da sessão — Consultar a sessão de scribe pelo consultationInternalId.
Smart Templates conduzem a documentação. Construa um com Seções Telepatia curadas para qualidade clínica, ou misture Seções Custom para seções não cobertas. Veja Smart Templates.

​
URL base

​
Versionamento da API

Todos os endpoints têm um prefixo de versão (ex. /v1/). A versão estável atual é v1. Quando mudanças incompatíveis forem introduzidas, uma nova versão será publicada e a anterior continuará disponível durante um período de deprecação. Veja o guia de versionamento para mais detalhes.

​
Autenticação

Todos os endpoints exigem um token Bearer (chave de API) no header Authorization. Fale com seu gerente de conta para obter sua chave de API. Veja o guia de autenticação para mais detalhes.

​
Downloads

Importe a API em qualquer ferramenta compatível com OpenAPI 3.1, ou carregue a coleção do Postman pronta direto no Postman ou Insomnia.

Doctor API — OpenAPI

Baixe a especificação da Doctor API (JSON).

Doctor API — Postman

Importe a Doctor API no Postman ou Insomnia.

Institutional API — OpenAPI

Baixe a especificação da Institutional API (JSON).

Institutional API — Postman

Importe a Institutional API no Postman ou Insomnia.

​
Próximos passos

Smart Templates

Desenhe como a Telepatia gera cada prontuário — o ponto de partida recomendado.

Início rápido

Percorra o fluxo de integração completo em menos de 5 minutos.

Prompts Telepatia

Prompts curados mantidos pela equipe clínica da Telepatia.

Referência da API

Explore todos os endpoints disponíveis.