Saltar al contenido principal
Visión general de la API

Tres endpoints de procesos y dos probes de salud.

Markdown

Human Plugin se sirve por HTTP plano en el puerto que configures (por defecto 8080). La URL base es el lugar donde expongas el contenedor dentro de tu red, por ejemplo http://human-plugin.internal:8080.

MétodoRutaPropósito
POST/v1/processesCrear un proceso, con uno de los flujos
GET/v1/processes/{id}Obtener un proceso
GET/v1/processes/{id}/selfieObtener la selfie
GET/health/liveLiveness. Consulta Salud y monitoreo
GET/health/readyReadiness (ping a la base de datos)

No hay ningún endpoint para listar, eliminar o buscar procesos, ni un receptor de webhooks.

Reglas que se aplican a todas las llamadas​

  • Sin encabezado de autenticación. Human Plugin no valida a quien llama. Restringe el acceso de red en su lugar: consulta Redes y seguridad.
  • Solo JSON, con nombres de campo en camelCase.
  • Las respuestas llevan Cache-Control: no-store.
  • Los errores usan un único envelope, {"message": "INVALID_REQUEST", "details": []}. Consulta Errores y reintentos.
  • id es el id de proceso de Human Plugin. Guárdalo de la creación: es como lees el proceso después.

Secuencia típica​

Siguiente: Crear un proceso.