Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

CE-RISE Hex Core Service Documentation

This site contains the technical documentation for the CE-RISE hex-core-service.

Use the navigation sidebar to access architecture, API, configuration, deployment, adapter contract, and operations documentation.


First 5 Minutes

This quickstart verifies that the service is reachable and can process one validation request.

1. Start the service

Run your deployed container (or local instance) with the required environment variables configured.

2. Check health

curl http://localhost:8080/admin/health

Expected response:

{"status":"ok"}

3. Check loaded models

curl http://localhost:8080/models

Pick one model and version from the response.

4. Validate a payload

curl -X POST "http://localhost:8080/models/<model>/versions/<version>:validate" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "payload": {
      "id": "example-001",
      "name": "example record"
    }
  }'

Expected response shape:

{
  "passed": true,
  "results": []
}

If your auth mode is none, you can omit the Authorization header.


Funded by the European Union under Grant Agreement No. 101092281 — CE-RISE.
Views and opinions expressed are those of the author(s) only and do not necessarily reflect those of the European Union or the granting authority (HADEA). Neither the European Union nor the granting authority can be held responsible for them.

CE-RISE logo

© 2026 CE-RISE consortium.
Licensed under the European Union Public Licence v1.2 (EUPL-1.2).
Attribution: CE-RISE project (Grant Agreement No. 101092281) and the individual authors/partners as indicated.

NILU logo

Developed by NILU (Riccardo Boero — ribo@nilu.no) within the CE-RISE project.