Stream person

Send your key as Authorization: Bearer cym_test_…. Requires the results:read scope. Test keys read the simulator; live keys read your paired Cymos.

A Server-Sent Events stream. Each message carries an id, an event kind and a data line holding the same { data, meta } envelope as every JSON response. Reconnect with Last-Event-ID to resume. See Streaming.

id: 3f9c2a7d1b6e4c08.42.result
event: result
data: {"data":{"value":1,"timestamp":"2026-10-24T23:55:30.000Z","confidence":0.92,"object":"result","id":"res_01","signal":"heart_rate_bpm","room_id":"room_bedroom","device_id":"dev_bedroom","track_id":"trk_001","person_id":"person_001","model":{"id":"model_vitals","version":"demo-1"},"received_at":"2026-10-24T23:55:30.000Z","updated_at":"2026-10-24T23:55:30.000Z","revision":1},"meta":{"request_id":"req_01","project_id":"proj_demo","livemode":false,"generated_at":"2026-10-24T23:55:30.000Z"}}

• 429rate_limit_exceeded: Too many requests this minute for the key (or twice that across the project), or too many open streams for the project. Retry after the seconds in Retry-After.quota_exceeded: A live key's project has used its monthly live-hour cap. There is no Retry-After. Don't retry; raise the live-hour cap in the dashboard. Headers: Retry-After, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.
• 503live_unavailable: This operation has no live data for this project yet (for example, no paired Cymo covers it). Don't retry the same request; pair a Cymo that covers it, or build against a test key.service_unavailable: A dependency, such as API key verification, is unreachable, or the project is busy with another write. Retry after the seconds in Retry-After, with backoff.
• 4XXInvalid request, credential, permission or revision.
• defaultError with a stable code and request ID.

Every error is a { error, meta } envelope with a stable code. See Errors for each code and whether to retry.

import { Cymo } from "@cymos/sdk";

const cymo = new Cymo({ apiKey: process.env.CYMO_API_KEY! });

for await (const message of cymo.people.stream({ person_id: "person_001" })) {
  console.log(message.id, message.kind, message.data);
}

$ cymatics people stream --person-id person_001 --max-events 5

curl -N "https://api.cymatics.tech/v1/people/person_001/stream" \
  -H "Authorization: Bearer $CYMO_API_KEY" \
  -H "Accept: text/event-stream"

stream_person({ person_id: "person_001", duration_ms: 10000, max_samples: 20 })

The MCP tool stream_person calls this operation with your key. It watches the stream for duration_ms (up to 60 s) or until max_samples messages (up to 200), then returns them and says whether more followed.