POST /v1/ingest — Full Reference

Endpoint

POST https://api.nefesh.ai/v1/ingest
Content-Type: application/json
X-Nefesh-Key: your-api-key

Required Fields

FieldTypeDescription
session_idstringClient-generated UUIDv7
timestampISO 8601Max 24h old, max 5s future
(signal)variesAt least one signal field required

Signal Fields

Cardiovascular

FieldTypeRange
heart_ratenumber20–300 bpm
rmssdnumber0–500 ms
sdnnnumber0–500 ms
pnn50number0–100%
spo2number50–100%
mean_ibinumber200–2000 ms
ibi_countinteger1–120

Vocal

FieldTypeValues
tonestringhostile, anxious, frustrated, tense, hesitant, neutral, excited, focused, calm
speech_ratenumberwpm
pitch_variabilitynumberHz std dev

Visual

FieldTypeValues
expressionstringtense, frowning, surprised, concentrated, neutral, smiling, relaxed
gazestringwandering, averted, downward, direct
posturestringslouched, leaning_back, leaning_forward, upright
engagementnumber0–1

Response: HumanStateResponse

{
  "session_id": "string",
  "state": "calm|relaxed|focused|stressed|acute_stress",
  "stress_score": 0-100,
  "confidence": 0.0-1.0,
  "signals_received": ["cardiovascular", "vocal", ...],
  "recommendation": "string",
  "disclaimer": "Not a medical device."
}

Body Size Limit

Maximum 4 KB per request. Requests exceeding this limit receive HTTP 413.