Skip to main content

​
Primeiros passos com a API

Este guia te ajudará a fazer sua primeira chamada à API e processar um áudio de consulta veterinária em poucos minutos.

​
Passo 1: Obtenha sua API Key

1

Crie sua conta

Entre em contato conosco via WhatsApp para solicitar acesso à API
2

Receba suas credenciais

Nossa equipe fornecerá sua API Key e instruções de acesso
3

Configure o ambiente

Use o endpoint base: https://api-sandbox.connectvets.com.br/notes/v1
Importante: Mantenha sua API Key segura e nunca a exponha em código frontend.

​
Passo 2: Teste a conexão

Vamos verificar se sua API Key está funcionando: 
curl -X GET "https://api-sandbox.connectvets.com.br/notes/v1/notes" \
  -H "X-API-KEY: sua_api_key_aqui" \
  -H "Content-Type: application/json"
Resposta esperada: 
{
  "data": [],
  "meta": {
    "total": 0,
    "page": 1,
    "limit": 10
  },
  "status": "success"
}

​
Passo 3: Envie seu primeiro áudio

Agora vamos processar um arquivo de áudio: 
curl -X POST "https://api-sandbox.connectvets.com.br/notes/v1/notes" \
  -H "X-API-KEY: sua_api_key_aqui" \
  -F "audio=@caminho/para/audio.mp3" \
  -F "metadata={\"patient_name\":\"Rex\",\"owner_name\":\"João Silva\"}"
Resposta esperada: 
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Rex", 
    "transcription_status": "pending",
    "created_at": "2024-01-15T10:30:00Z"
  },
  "status": "success"
}

​
Passo 4: Monitore o processamento

O processamento é assíncrono. Verifique o status: 
curl -X GET "https://api-sandbox.connectvets.com.br/notes/v1/notes/550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-KEY: sua_api_key_aqui"

​
Passo 5: Obtenha os resultados

Quando o status for completed, você pode acessar as seções: 
curl -X GET "https://api-sandbox.connectvets.com.br/notes/v1/notes/550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-KEY: sua_api_key_aqui"
Exemplo de resposta completa: 
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Rex",
    "transcription_status": "completed",
    "note_sections": [
      {
        "title": "Anamnese",
        "label": "anamnesis", 
        "content": "Paciente apresenta histórico de...",
        "order": "1"
      },
      {
        "title": "Diagnóstico",
        "label": "diagnosis",
        "content": "Após exame físico, diagnosticado...",
        "order": "2" 
      }
    ]
  }
}

​
🎯 Próximos passos

Explore a API

Veja todos os endpoints disponíveis

Configure Webhooks

Receba notificações automáticas

Formatos de áudio

Otimize a qualidade dos seus áudios

Tratamento de erros

Implemente tratamento robusto de erros
Dica: Use webhooks para receber notificações automáticas quando o processamento for concluído, ao invés de fazer polling manual.