Skip to main content
GET
/
notes
/
{noteId}
/
status
Obter status da nota
curl --request GET \
  --url https://api-sandbox.connectvets.com.br/notes/v1/notes/{noteId}/status \
  --header 'X-API-KEY: <api-key>'
{
  "data": {
    "status": "completed",
    "valid": true
  }
}

​
Casos de Uso

Este endpoint é ideal para:
  • Polling de status: ⚡ Verificar periodicamente se uma transcrição foi concluída (sem rate limiting!)
  • Integração assíncrona: Aguardar conclusão antes de buscar dados completos
  • Monitoramento: Acompanhar o progresso de processamento em lote
  • UI responsiva: Atualizar interface com status em tempo real

​
Exemplo de Polling Eficiente

async function pollNoteStatus(noteId, maxAttempts = 60) {
  for (let attempt = 0; attempt < maxAttempts; attempt++) {
    const response = await fetch(`/notes/${noteId}/status`, {
      headers: { 'X-API-KEY': 'sua_api_key' }
    });
    
    const { data } = await response.json();
    
    if (data.status === 'completed' || data.status === 'failed') {
      return data;
    }
    
    // Aguardar 5 segundos antes da próxima verificação
    await new Promise(resolve => setTimeout(resolve, 5000));
  }
  
  throw new Error('Timeout: Status polling exceeded maximum attempts');
}

​
Notas Importantes

Rate Limiting: ⚡ Este endpoint NÃO possui rate limiting, permitindo verificações frequentes quando necessário.
Recomendação: Mesmo sem rate limiting, implemente um intervalo de pelo menos 5 segundos entre verificações de status da mesma nota para evitar sobrecarga desnecessária do servidor.
Notas com status completed podem ainda ter valid: false se falharam na validação. Use o endpoint /notes/{noteId} para obter detalhes sobre possíveis erros.

Authorizations

​
X-API-KEY
string
header
required

API Key para autenticação

Path Parameters

​
noteId
string<uuid>
required

ID da nota para verificar o status

Response

Status retornado com sucesso

​
data
object
Example:
{ "status": "completed", "valid": true }