📖 API Reference

Referencia completa de todos los endpoints de la NERHIA REST API

Base URL: https://nerhia-api-852702111467.us-central1.run.app

Autenticación: Endpoints protegidos requieren el header X-Api-Key. Los endpoints marcados como 🔓 requieren autenticación. Los marcados como 🔑 requieren rol admin.

🎬 Core — Render

GET/statusEstado del sistema

Retorna versión, uptime, conteos de jobs y módulos activos.

curl https://nerhia-api-.../status

{ "status": "ok", "version": "3.0.0", "uptime": 3600, "totalJobs": 42, "modules": { "queue": true, "analytics": true, ... } }

POST/render🔓 AuthCrear render de video

Parámetro	Tipo	Requerido	Descripción
location	string	req	Ubicación del reporte
compositionId	string	opt	Template (default: NERHIAReport)
pm25	number	opt	PM2.5 µg/m³
priority	string	opt	critical\|high\|normal\|low

curl -X POST .../render \ -H "X-Api-Key: $KEY" \ -H "Content-Type: application/json" \ -d '{"location":"Santiago","compositionId":"NERHIAReport"}'

{ "ok": true, "jobId": "...", "statusUrl": "/render/..." }

GET/render/:idEstado de un render

Retorna estado, videoUrl (si done), duración y metadata del job.

POST/batch🔓 AuthBatch render

Envía un array de renders para procesar en cola con prioridad baja.

{ "renders": [{"location":"A"}, {"location":"B"}] }

🤖 AI Engine

POST/ai/render🔓 AuthRender por prompt IA

{ "prompt": "genera un reporte de calidad del aire para Santiago" }

📥 Ingest

POST/ingest🔓 AuthSubir PDF/imagen → contexto

Multipart/form-data con campo "file". Acepta PDF, PNG, JPG.

⏱️ Job Queue

GET/queue/stats🔓 AuthEstado de la cola

{ "pending":5, "running":2, "done":100, "failed":3, "successRate":97, "byPriority":{...} }

🔔 Webhooks

POST/webhooks🔓 AuthCrear webhook

{ "name":"Slack Notifier", "url":"https://...", "events":["render.completed"], "secret":"..." }

📈 Analytics

GET/analytics/overview🔓 AuthMétricas generales

Retorna renders totales, success rate, avg duration, trends, etc.

🏗️ Architecture (v3.0.0)

GET/architectureMapa arquitectónico

Retorna layers, roles, navigation map y estadísticas del sistema.

GET/nav?role=userNavegación filtrada por rol

Retorna items de navegación disponibles según el rol del usuario.

⚡ SDK Downloads

GET/sdk/jsDescargar SDK JavaScript

Descarga nerhia-client.js — SDK JavaScript con zero dependencies.

GET/sdk/pythonDescargar SDK Python

Descarga nerhia_client.py — SDK Python con solo stdlib.

¿Necesitas más detalles? Usa el API Explorer para probar endpoints en vivo, o descarga el SDK para integrar.