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

HTTP API reference

Compact reference for the Jev-compatible HTTP API. For a guided version with examples, see Calling the API.

Base URL (default): http://127.0.0.1:8080.

Routes

MethodPathPurpose
POST/v1/systemoneEvaluate a state against typed questions.
GET/v1/modelsList the served model.
GET/healthReadiness and model startup time.
GET/health/liveLiveness; independent of the model.

POST /v1/systemone request

FieldTypeRequiredNotes
modelstringyesServed name (default typed-lm)
statestring or JSONyesThe facts of the case
questionsobjectyesNon-empty map of question name to question

Question types

typeRequired fieldsCandidates
noulinstructionsOptional criteria {"yes","no"}
choiceinstructions, criteria (object)One entry per option
scoreinstructions, criteria (array)2 to 10 levels, increasing

POST /v1/systemone response

FieldTypeNotes
modelstringEchoes the resolved model
answersobjectOne entry per question name
usage.input_tokensintegerPrompt tokens
usage.output_tokensintegerDecision positions read

Answer shapes

typeFields
noulnoul (0.0 to 1.0)
choicechoice, probabilities, confidence
scorescore, legend, probabilities, confidence

Status codes

StatusSituation
200Success
404Unknown model
422Malformed body or question outside the contract
500Inference failure

Error envelope:

{ "error": { "message": "..." } }

GET /v1/models

{
  "object": "list",
  "data": [{ "id": "typed-lm", "object": "model", "owned_by": "typed-lm" }],
  "models": [
    { "name": "typed-lm", "description": "typed-lm model served from context '...'", "release_date": "unknown" }
  ]
}

GET /health

{ "status": "ok", "startup_seconds": 12.3 }

GET /health/live

{ "status": "ok" }

Next steps