Referencia API

Referencia completa de todos los endpoints de la API REST de Auralytik. Cada solicitud requiere autenticacion y retorna respuestas en formato JSON.

Descripcion General

URL Basehttps://api.auralytik.ai/api/v1
ProtocoloSolo HTTPS (TLS 1.2+)
Tipo de Contenidoapplication/json
AutenticacionEncabezado X-Api-Key + firma HMAC de solicitudes. Mas informacion
Swagger UIapi.auralytik.ai/swagger
Health CheckGET /health (no requiere autenticacion)

Formato de Respuesta

Respuesta Exitosa

{
  "data": { ... },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-03-30T12:00:00Z"
  },
  "pagination": {
    "page": 1,
    "pageSize": 25,
    "totalCount": 142,
    "totalPages": 6
  }
}

Respuesta de Error

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests.",
    "requestId": "req_abc123",
    "retryAfter": 30
  }
}

Endpoints

Todas las rutas son relativas a la URL base.

Evaluaciones

evaluations:read
MetodoEndpoint
GET/evaluationsListar evaluaciones con filtros
GET/evaluations/{id}Obtener evaluacion por ID
GET/evaluations/{id}/transcriptObtener transcripcion
GET/evaluations/{id}/resultsObtener resultados del analisis IA

Archivos de Audio

audio:readaudio:downloadaudio:write
Documentacion completa
MetodoEndpoint
GET/audio-filesListar archivos de audio con filtros
GET/audio-files/{id}Obtener archivo de audio por ID
GET/audio-files/{id}/download-urlObtener URL de descarga (token SAS)
GET/audio-files/{id}/transcriptObtener transcripcion
POST/audio-files/upload-urlObtener URL de carga pre-firmada
POST/audio-files/{id}/processIniciar procesamiento IA
GET/audio-files/{id}/processing-statusVerificar estado de procesamiento

Analytics

analytics:readanalytics:export
MetodoEndpoint
GET/analytics/summaryObtener resumen de analytics
GET/analytics/campaignsAnalytics a nivel de campana
GET/analytics/call-centersAnalytics de call centers
GET/analytics/executivesAnalytics de rendimiento de ejecutivos
GET/analytics/trendsDatos de tendencia en el tiempo
POST/analytics/exportIniciar trabajo de exportacion de analytics
GET/analytics/export/{jobId}Obtener estado del trabajo de exportacion

Exportaciones

analytics:export
Documentacion completa
MetodoEndpoint
POST/exports/ai-callsIniciar exportación asincrónica de Llamadas IA (CSV o Excel)
GET/exports/{jobId}Consultar estado y URL de descarga del trabajo

Engagements

engagements:readengagements:write
MetodoEndpoint
GET/engagementsListar engagements
GET/engagements/{id}Obtener engagement por ID
POST/engagementsCrear engagement
PATCH/engagements/{id}Actualizar engagement

Conversaciones

conversations:read
MetodoEndpoint
GET/conversationsListar conversaciones
GET/conversations/{id}Obtener conversacion por ID
GET/conversations/{id}/messagesObtener mensajes de la conversacion

Llamadas de Voz

voice:read
MetodoEndpoint
GET/voice-callsListar llamadas de voz
GET/voice-calls/{id}Obtener llamada de voz por ID
GET/voice-calls/{id}/recording-urlObtener URL de grabacion
GET/voice-calls/{id}/epa-resultsObtener resultados del analisis EPA

Campanas

campaigns:read
MetodoEndpoint
GET/campaignsListar campanas
GET/campaigns/{id}Obtener campana por ID

Webhooks

webhooks:manage
Documentacion completa
MetodoEndpoint
GET/webhooksListar suscripciones de webhooks
POST/webhooksCrear suscripcion de webhook
PATCH/webhooks/{id}Actualizar webhook
DELETE/webhooks/{id}Eliminar webhook
POST/webhooks/{id}/testEnviar evento de prueba
GET/webhooks/{id}/deliveriesObtener historial de entregas

Claves API

keys:manage
MetodoEndpoint
GET/api-keysListar claves API
POST/api-keysCrear clave API
PATCH/api-keys/{id}Actualizar clave API
DELETE/api-keys/{id}Revocar clave API
POST/api-keys/{id}/rotateRotar secreto de clave API

Uso

usage:read
MetodoEndpoint
GET/usage/summaryObtener resumen de uso del periodo de facturacion
GET/usage/detailsObtener registros detallados de uso
GET/usage/by-keyObtener desglose de uso por clave API

Codigos de Error

HTTPCodigo
401INVALID_API_KEYLa clave API falta, esta mal formada o fue revocada
401INVALID_SIGNATURELa firma HMAC no coincide
401TIMESTAMP_EXPIREDEl timestamp de la solicitud esta fuera de la ventana permitida
403INSUFFICIENT_SCOPELa clave API no tiene el alcance requerido para este endpoint
403IP_NOT_ALLOWEDLa IP de origen de la solicitud no esta en la lista blanca
404RESOURCE_NOT_FOUNDEl recurso solicitado no existe
429RATE_LIMIT_EXCEEDEDDemasiadas solicitudes; reintenta despues del periodo indicado
500INTERNAL_ERRORError inesperado del servidor; contacta soporte si persiste
503SERVICE_UNAVAILABLEServicio temporalmente no disponible; reintenta con backoff

Autenticacion requerida

Cada solicitud (excepto /health) debe incluir un encabezado X-Api-Key valido y firma HMAC.

Guia de Autenticacion