Headless Web SDK Types Reference

In React and TypeScript, types and interfaces describe the shape of objects you pass into hooks, props, and APIs. They tell your editor what fields exist, which are required, and what you get back from a function, so you catch mistakes early and autocomplete stays accurate. This reference lists the Headless Web SDK types you will see alongside Authentication, Ambient session creation, and Ambient session control. They are grouped below the same way you tend to use them in an app: first identity and tokens, then session context and session hook inputs and outputs. Open a card when you need the exact field list, optional vs required flags, and how a type connects to a hook or flow.

Authentication and tokens

Use these types when you configure useAuth, read results from login or registration, or type the payload when your backend refreshes a partnerToken.

UseAuthParams

Use this type to pass partnerId, partnerToken, and auto-registration settings to useAuth

LoginResponse

Use this type to read suki_token and jwt_bearer after login() succeeds

RegistrationResponse

Use this type to type the success response from registerUser()

UpdatePartnerTokenResponse

Use this type to read refreshed tokens after updatePartnerToken()

Type	What it is	Use case
`UseAuthParams`	Object type for `useAuth` hook arguments	When you initialize auth in a root component and need typed `partnerId`, `partnerToken`, and auto-registration settings before any Ambient call
`LoginResponse`	Object type with `suki_token` and `jwt_bearer`	When `login()` resolves and you store tokens, update app state, or pass credentials to your backend
`RegistrationResponse`	Empty object type (`Record<string, never>`)	When `autoRegister` is `false` and you call `registerUser()` in a separate step before `login()`
`UpdatePartnerTokenResponse`	Object type with refreshed `suki_token` and `jwt_bearer`	When your app rotates `partnerToken` after SSO refresh or a scheduled token exchange and you call `updatePartnerToken()`

Ambient session

Use these types when you pass session context, configure useAmbientSession, or type values from sessionStatus in your UI.

SessionContext

Use this type to send patient, provider, visit, and diagnosis fields with setSessionContext

UseAmbientSessionParams

Use this type to pass ambientSessionId, audio callbacks, and onSessionTerminatedByPeer to useAmbientSession

UseAmbientSessionReturn

Use this type to type start, pause, submit, cancelRemote, endRemote, and sessionStatus

AmbientSessionStatus

Use this type for server lifecycle values such as created, submitted, and completed

Type	What it is	Use case
`SessionContext`	Object type for session metadata sent to Suki	When you call `setSessionContext` after `start()` to improve note quality, or before a Web SDK handoff when you need `patient_id` and structured `name` on the shared note
`UseAmbientSessionParams`	Object type for `useAmbientSession` hook arguments. SDK export name: `UseAmbientSessionProps`	When `useAmbient` returns `ambientSessionId` and you attach recording controls, an audio visualizer, or a handler for another product ending the live session
`UseAmbientSessionReturn`	Object type for the `useAmbientSession` return value	When you build a recording component that calls `start`, `pause`, and `submit`, or resolves a `sessionAlreadyExists` conflict with `cancelRemote` or `endRemote`
`AmbientSessionStatus`	String union of server-side session lifecycle values	When you show note progress on Suki’s servers, for example waiting on `submitted` or showing `completed`, separate from your local recording UI state

For end-to-end workflows, refer to Ambient interoperability, Handle ambient session conflicts, and Read shared ambient notes.

Next steps

Refer to Provider for more information on how to wrap your application with the PlatformClient and PlatformClientProvider before using hooks.

Get Started

Concepts & Feature Guides

API Reference

Resources

Headless Web SDK Types Reference

Authentication and tokens

UseAuthParams

LoginResponse

RegistrationResponse

UpdatePartnerTokenResponse

Ambient session

SessionContext

UseAmbientSessionParams

UseAmbientSessionReturn

AmbientSessionStatus

Next steps

​Authentication and tokens

UseAuthParams

LoginResponse

RegistrationResponse

UpdatePartnerTokenResponse

​Ambient session

SessionContext

UseAmbientSessionParams

UseAmbientSessionReturn

AmbientSessionStatus

​Next steps

Authentication and tokens

Ambient session

Next steps