Rela AIRela AI Docs
Referencia de API

Referencia de API — Vista General

URL base, autenticacion JWT, rate limits por plan, formato de errores, codigos de estado y versionado.

URL Base

Todas las solicitudes se dirigen a:

https://api.relaai.com/api/v1/

Las solicitudes internas entre microservicios usan:

http://internal-api:8000/api/v1/

Autenticacion

La API usa JSON Web Tokens (JWT) emitidos al iniciar sesion. Incluye el token en el header Authorization:

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
Campo del JWTDescripcion
subID del usuario
tenant_idID del tenant
roleRol del usuario
permissionsLista de permisos
expExpiracion (15 minutos por defecto)

Los tokens se refrescan via POST /api/v1/auth/refresh con el refresh token.

Rate Limits por Plan

PlanRequests/minBurst maximo
Free3010
Starter12030
Professional600100
Enterprise3,000500

Headers de respuesta incluidos en cada solicitud:

  • X-RateLimit-Limit — Limite total de la ventana
  • X-RateLimit-Remaining — Solicitudes restantes
  • X-RateLimit-Reset — Timestamp de reset (Unix epoch)

Formato de Errores

Todos los errores siguen un formato consistente:

{
  "detail": "Resource not found",
  "error_code": "NOT_FOUND",
  "request_id": "req_abc123"
}

Codigos de Estado

CodigoSignificado
200Operacion exitosa
201Recurso creado
204Eliminado sin contenido
400Solicitud invalida
401No autenticado
403Sin permisos o limite de plan
404Recurso no encontrado
409Conflicto (duplicado)
422Error de validacion
429Rate limit excedido
500Error interno del servidor

Paginacion

Los endpoints de listado soportan paginacion con skip y limit:

GET /api/v1/agents?skip=0&limit=20

La respuesta incluye metadatos de paginacion en el cuerpo.

Versionado

La version actual es v1. Cuando una nueva version este disponible, los headers de deprecacion indicaran la ruta de migracion:

Deprecation: true
Sunset: Sat, 01 Jan 2027 00:00:00 GMT
Link: </api/v2/resource>; rel="successor-version"

Endpoints Internos

Algunos endpoints estan reservados para comunicacion entre servicios:

EndpointUso
POST /internal/eventsIngesta interna de eventos
POST /internal/notificationsCola de notificaciones
GET /internal/healthHealth check del servicio

Estos endpoints requieren un token de servicio interno y no estan expuestos en la API publica.

En esta página