> ## Documentation Index
> Fetch the complete documentation index at: https://docs.telepatia.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão geral da Scribe API

> API REST externa para integração com a Telepatia

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

0. **Escolher (ou construir) um Smart Template** -- Defina quais seções a Telepatia gera usando [Prompts Telepatia](/pt-BR/scribe-api/telepatia-nodes) curados. Reutilize entre consultas.
1. **Definir contexto da consulta** -- Preencher dados do paciente e anexar o Smart Template (JSON inline ou por `medicalRecordConfigurationId`).
2. **Gerar um link de login** -- Criar um código de verificação pra abrir o scribe, passando o `consultationInternalId`.
3. **Realizar a sessão** -- O médico usa o scribe pra gravar e finalizar a consulta.
4. **Buscar resultados da sessão** -- Consultar a sessão de scribe pelo `consultationInternalId`.

<Tip>
  **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](/pt-BR/scribe-api/smart-templates).
</Tip>

## URL base

| Ambiente | URL base                          |
| -------- | --------------------------------- |
| Produção | `https://scribe-api.telepatia.ai` |

## 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](/pt-BR/scribe-api/versioning) 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](/pt-BR/scribe-api/authentication) 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.

<CardGroup cols={2}>
  <Card title="Doctor API — OpenAPI" icon="file-code" href="/pt-BR/scribe-api/openapi.json">
    Baixe a especificação da Doctor API (JSON).
  </Card>

  <Card title="Doctor API — Postman" icon="rocket" href="/pt-BR/scribe-api/synapse-doctor.postman_collection.json">
    Importe a Doctor API no Postman ou Insomnia.
  </Card>

  <Card title="Institutional API — OpenAPI" icon="file-code" href="/pt-BR/scribe-api/openapi-institutional.json">
    Baixe a especificação da Institutional API (JSON).
  </Card>

  <Card title="Institutional API — Postman" icon="rocket" href="/pt-BR/scribe-api/synapse-institutional.postman_collection.json">
    Importe a Institutional API no Postman ou Insomnia.
  </Card>
</CardGroup>

## Próximos passos

<CardGroup cols={2}>
  <Card title="Smart Templates" icon="wand-magic-sparkles" href="/pt-BR/scribe-api/smart-templates">
    Desenhe como a Telepatia gera cada prontuário — o ponto de partida recomendado.
  </Card>

  <Card title="Início rápido" icon="rocket" href="/pt-BR/scribe-api/quickstart">
    Percorra o fluxo de integração completo em menos de 5 minutos.
  </Card>

  <Card title="Prompts Telepatia" icon="stethoscope" href="/pt-BR/scribe-api/telepatia-nodes">
    Prompts curados mantidos pela equipe clínica da Telepatia.
  </Card>

  <Card title="Referência da API" icon="square-terminal" href="/pt-BR/scribe-api/api-reference">
    Explore todos os endpoints disponíveis.
  </Card>
</CardGroup>