Exportar nota
Notes
Exportar Nota
Exporta o prontuário completo em diferentes formatos para download direto.
Requisito: O export só está disponível para notas com transcription_status: "completed".
Rate Limiting: Este endpoint está sujeito aos limites da sua API Key (padrão: 100 req/min, 1000 req/hora).
GET
Exportar nota
Descrição
Exporta o prontuário completo de uma nota em diferentes formatos para download direto. O export inclui todas as seções estruturadas da nota formatadas apropriadamente.Parâmetros da Requisição
Path Parameters
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
noteId | UUID | ✅ Sim | ID único da nota |
Headers
| Header | Obrigatório | Valor |
|---|---|---|
X-API-KEY | ✅ Sim | Sua chave de API |
Query Parameters
| Parâmetro | Tipo | Obrigatório | Descrição | Padrão |
|---|---|---|---|---|
format | String | ❌ Não | Formato de export: rtf ou txt | txt |
Formatos Disponíveis
TXT (Texto Simples)
- Content-Type:
text/plain; charset=utf-8 - Estrutura: Texto simples e estruturado com hierarquia
- Codificação: UTF-8
- Uso: Compatibilidade máxima, fácil integração
RTF (Rich Text Format)
- Content-Type:
application/rtf - Estrutura: Formatação rica com cores e fontes
- Características:
- Títulos em azul e negrito
- Seções organizadas com cores diferentes
- Fontes apropriadas (Arial para títulos, Times New Roman para conteúdo)
- Uso: Documentos profissionais, compatível com Word
Exemplos de Requisição
Exportar em formato TXT (padrão)
Exportar em formato RTF
JavaScript/TypeScript
Python
Resposta de Sucesso (200 OK)
Headers de Resposta
Exemplo de Conteúdo TXT
Tratamento de Erros
400 Bad Request
404 Not Found
422 Unprocessable Entity
Casos de Uso
Export Automático após Processamento
Export em Lote
Integração com Sistema Local
Boas Práticas
📄 Escolha do Formato
- TXT: Use para integrações automatizadas, processamento de texto, compatibilidade máxima
- RTF: Use para documentos profissionais, apresentações, quando formatação é importante
🔄 Cache e Performance
- Cache exports localmente quando possível
- Use o export apenas quando necessário (após
transcription_status: completed) - Para múltiplos exports, considere fazer em lote com controle de rate

