UseAmbientSessionReturn Type - Suki

Type definition

Below is the type definition for the UseAmbientSessionReturn type. This is the type definition for what the useAmbientSession hook returns. It includes methods to control the session and state information about the current session.

type UseAmbientSessionReturn = {
  start: () => Promise<void>;
  pause: () => Promise<void>;
  resume: () => Promise<void>;
  cancel: () => Promise<void>;
  submit: () => Promise<void>;
  setSessionContext: (sessionContext: Omit<SessionContext, "ambientSessionId">) => Promise<void>;
  cancelRemote: (params: { ambientSessionId: string }) => Promise<void>;
  endRemote: (params: { ambientSessionId: string }) => Promise<void>;
  sessionStatus: AmbientSessionStatus | null | undefined;
  sessionType: "online" | "offline" | null;
};

Method or field	Description
`setSessionContext`	Sends session context. Returns `Promise<void>`. Throws on failure.
`cancelRemote`	Cancels a remote blocking session. Pass `blockingSessionId` from a `sessionAlreadyExists` error.
`endRemote`	Ends a remote blocking session so captured audio can be processed.
`sessionStatus`	Server-side lifecycle. Can be `null` or `undefined` before the store has state.
`sessionType`	Whether the session is online or offline. `null` until reported.

For interoperability workflows, refer to Ambient interoperability and Handle ambient session conflicts.

Last modified on September 2, 2026