Stimulation

Request a tES (tDCS/tACS) session (HALO+ only)

post

https://api.haloproject.com/v1https://sandbox.api.haloproject.com/v1

/stimulation/tes

Locked behind clinician & regulator gates. Enforces absolute safety limits in software & firmware.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

tDCS/tACS parameters. Enforced limits: max_current <= 2.0 mA; max_current_density <= 0.5 mA/cm^2; duration <= 20 min; cooldown >= 24h per site. Requires clinician approval.

typestring · enumRequiredPossible values:

montagestringRequiredExample: anodal_F3_cathodal_Fpz

current_mAnumber · max: 2Required

frequency_Hznumber | nullableOptional

For tACS only

phase_lockbooleanOptional

If true, aligns to EEG phase (research)

duration_minutesinteger · max: 20Required

rationalestringOptional

Responses

202

Accepted (if enabled)

application/json

403

Locked in this environment

post

/stimulation/tes

HTTPcURLJavaScriptPython

POST /v1/stimulation/tes HTTP/1.1
Host: api.haloproject.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "type": "tDCS",
  "montage": "anodal_F3_cathodal_Fpz",
  "current_mA": 1,
  "frequency_Hz": 1,
  "phase_lock": true,
  "duration_minutes": 1,
  "rationale": "text"
}

{
  "status": "ok",
  "id": "text"
}