Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
🚀 New Patient Summary APIs are out! Refer to the Release notes for details.
Lifecycle status values for an Ambient session in the Headless Web SDK
sessionStatus from useAmbientSession lets you know the Ambient session lifecycle on Suki’s servers. Examples include created and submitted.
sessionStatus for recording versus paused. Keep a local phase value such as idle, recording, or paused. Update phase when you call start, pause, or resume.type AmbientSessionStatus =
| "created"
| "submitted"
| "completed"
| "cancelled"
| "aborted"
| "failed"
| "skipped"
| "not_found"
| "error";
| Value | When you see it |
|---|---|
created | Session exists and you can start recording. |
submitted | Recording finished and the session was submitted for processing. |
completed | Note generation finished. |
cancelled | Session was cancelled. |
aborted / failed / skipped / not_found / error | Terminal or error outcomes. Handle these in your UI as needed. |
phase together with sessionStatus.Was this page helpful?
Suggestions