Sentinel

API v1 — Overview

REST sobre HTTPS, JSON body, errores tipados. Versionado por path (/v1). Compatible con cualquier HTTP client; ofrecemos un SDK TS oficial.

Base URL

https://sentinel.hivium.app/v1

Versionado

La versión va en el path. Una versión es estable: no introducimos breaking changes dentro de /v1. Cambios breaking → /v2 con periodo de overlap mínimo 6 meses.

Spec OpenAPI

La spec en /v1/openapi.json es la fuente de verdad machine-readable. Postman collection (placeholder hasta publicarla): próximamente.

IDs y formato

  • IDs: strings opacos con prefijo (cnt_…, conv_…, msg_…, run_…).
  • Timestamps: ISO 8601 UTC (2026-05-14T12:34:56Z).
  • Boolean: true / false.
  • Currency: minor units (centavos), con campo currency ISO 4217.

Paginación

Cursor-based en endpoints list. Query params: limit (default 25, max 100), cursor (id del último item). La respuesta incluye data[] y next_cursor.

GET /v1/contacts?limit=50&cursor=cnt_abc123

{
  "data": [ ... 50 items ... ],
  "next_cursor": "cnt_xyz789",
  "has_more": true
}

Idempotencia

Los endpoints write aceptan un header Idempotency-Key (UUID). Misma key dentro de 24h → misma respuesta, no se duplica. Si querés reintentar un envío sin riesgo, generá un UUID y reusalo.

Próximo: crear una API key.