Report stimulation
Tells the analysis when stimulation starts, stops or changes, if your
product controls it (a device, an e-stim unit, a scene). Imminence
read from the face alone does not know how long the person has been
stimulated; once you report it, imminence accounts for that, and
imminence.updated carries stimulationAware: true.
Report the device too, and a heads-up display can show it beside the
person's signals: its level and the most it will go to, each
channel's level, its mode, and who sets the level. A report updates
the fields it carries and keeps the ones it omits; send null to
clear one. Each report reaches the session's readers as
stimulation.updated, at most four a second, reports in between
merged into the next.
Report every change, not a heartbeat. Optional; works with the
session's client token, so a device can report for itself. A device
that changes often can send the same report as a stimulation
message on the socket (results.websocketUrl) instead.
Stopping is how orgasm.dev tells a ruin from an orgasm: an orgasm that
begins within 30 seconds of an off reported while p30 was at 0.75
or above is a ruin, and its orgasm.end says ruined: true.
AuthorizationBearer <sk_test_… or sk_live_…>A secret key, sent as Authorization: Bearer sk_test_…. Keep it on your server. Test keys reach the sandbox; live keys reach live analysis. In the sandbox any key that starts with sk_test_ works.
sessionId*stringThe live session's id.
^ls_[0-9a-z]{20}$Idempotency-Key?stringA unique value, such as a UUID, that makes retrying this request safe: a retry with the same key and body within 24 hours returns the first response (with Idempotent-Replayed: true) instead of acting twice. The same key with a different body is refused with idempotency_key_reused.
1 <= length <= 255The new stimulation state.
application/json- body
A change in stimulation, reported by your product. Every field but state is optional; one you omit keeps the value you last reported, and null clears it.
state*stringWhether stimulation is now on or off. An off while p30 is at 0.75 or above, followed within 30 seconds by an orgasm, makes that orgasm a ruin.
"on""off"intensity?|The intensity now, from 0 to 1 on your product's own scale. Omit it if your product has no intensity.
0 <= value <= 1level?|The device's level now, on its own scale (for example 0 to 100).
0 <= valuelevelMax?|The highest level the device will go to now, on the same scale; a display fills a bar toward it.
0 < valuechannels?array<>|Each output's level, for a device with more than one (at most four).
items <= 4mode?|The device's mode or pattern, as your product names it (for example waves).
length <= 40modeLabel?|The mode's name to show the person; without it a display shows mode in words.
length <= 40device?|nulldrive?|Who sets the level: auto (your product, following the person's signals), manual (the person's own hand), hold (held where it is) or paused.
"auto""manual""hold""paused"nullstreamTimeS?numberWhen the change happened, in stream seconds. Omit it to mean now.
0 <= valueThe report was recorded.
application/json- response
Confirms a stimulation report, with the stimulation as it now stands: this report merged over the ones before it.
object*stringsessionId*stringstate*string"on""off"intensity*number|nullstreamTimeS*numberstimulationAware*booleanImminence now accounts for time under stimulation.
stimulation*The stimulation your product last reported, merged across its reports: a report updates the fields it carries and keeps the rest. Fields your product never reported are null.
curl -X POST 'https://orgasm.dev/v1/live-sessions/ls_8f3kq2m7x9w4c1n6t5ra/stimulation' \ -H 'Content-Type: application/json' \ -d '{ "state": "on", "intensity": 0.4}'{ "object": "stimulation_report", "sessionId": "ls_8f3kq2m7x9w4c1n6t5ra", "streamTimeS": 300, "state": "on", "intensity": null, "stimulationAware": true, "stimulation": { "state": "on", "intensity": null, "level": 34, "levelMax": 60, "channels": [ { "id": "a", "level": 34, "levelMax": 60 }, { "id": "b", "level": 27, "levelMax": 60 } ], "mode": "waves", "modeLabel": "Waves", "device": { "label": "Unit", "connected": true }, "drive": "auto", "changedAtS": 300 }}Create a view token POST
A read-only token for one session's events, for a screen other than the person's device: a heads-up display drawn into a stream, a coach's view, a second monitor. It reads the session's events through the stream and the event list, in the `Authorization` header only, and nothing else: it cannot report stimulation, and it cannot read the session object with its metadata and references. `subject.identified` is left out unless `includeSubject` is true: the face read is the person's, and a display others watch should not show it unasked. For the same reason the face's channels, in `signals.updated` and in `face.frame`, are left out unless `includeFace` is true. The token stops working at `expiresAt`, or five minutes after the session ends, whichever comes first. Make one per screen.
List recordings GET
Lists your company's recordings, newest first.