API reference

startSession(existingSession?: { session_id: string; session_token: string }): Promise<SessionResponse>

sendMessage(options: SendMessageOptions): Promise<void>

callTool(tool_id: string, message_id: string, params?: Record<string, unknown>): Promise<void>

sendFeedback(messageId: string, feedback: USER_FEEDBACK, reason?: string): Promise<void>

on(event: SYNAPSE_REALTIME_EVENTS, listener: (...args: unknown[]) => void): void
off(event: SYNAPSE_REALTIME_EVENTS, listener: (...args: unknown[]) => void): void

startRecording(options: {
  onChunks: (chunks: AudioMetaData) => void;
  onError?: (error: Error) => void;
}): Promise<void>

endRecording(): void

getSessionConfig(): SessionResponse

getAgentConfig(): Promise<AgentConfigResponse>

isConnected(): boolean

get voice(): VoiceAgent

endSession(): void

interface SessionResponse {
  session_id: string;
  session_token?: string;
  session_validity_s?: string;
  user_id?: string;
  msg?: string;
  initial_message?: TInitialMessage;
}

type TContext = {
  profile?: {
    mobile?: string;
    name?: string;
    age?: number;
    gender?: string;
    marital_status?: string;
  };
  intent?: string;
  user_location?: { lat: number; long: number };
  referer?: string;
  [key: string]: unknown;
};

type Environment = "development" | "production" | "staging";

interface SynapseSDKCallbacks {
  onSessionRefreshed?: (session: SessionResponse) => void;
  onError?: (error: TSynapseError) => void;
}

interface TSynapseError {
  message: string;
  error?: { code?: string; msg?: string } & Record<string, unknown>;
  code?: string;
  status?: number;
  context?: Record<string, unknown>;
}

type ToolCallData = {
  tool_id: string | null;
  tool_type?: SYNAPSE_TOOL_TYPES;
  tool_name: string;
  details?: ToolDetails; // component, status, input, _meta
  meta?: Record<string, unknown>;
};