@fluxyte/sdk 0.4.0 → 0.4.2

package/README.md

@@ -3,6 +3,12 @@
 The official TypeScript SDK for the Fluxyte Onboarding AI API: a context-aware,
 documentation-grounded assistant designed for onboarding and setup flows (not generic chat).
 
+## What's New In 0.4.0
+
+- Voice chat API via `client.voiceChat(...)` for speech input.
+- Optional synthesized audio reply output.
+- React voice chat hook support for UI integration.
+
 ## Install
 
 ```bash
@@ -20,6 +26,29 @@ npm install @fluxyte/sdk
 
 Treat your API key like a password. Do not commit it to source control.
 
+### Create an API key
+
+1. Sign up at `https://fluxyte.com/signup`
+2. Verify your email
+3. Open the `Account` menu
+4. Select `API Keys`
+5. Click `Create API Key`
+6. Choose key type:
+   - `pk_*` (PUBLIC) for frontend/browser SDK usage
+   - `sk_*` (SECRET) for backend/server-only usage
+7. Copy your API key (shown once)
+
+### Use an API key
+
+All integrations authenticate with an API key sent in the `X-API-Key` header.
+
+- Use `pk_*` keys in browser/public SDK integrations
+- Use `sk_*` keys only in backend/server environments
+- For `pk_*` keys, configure allowed origins to restrict frontend domains
+- The key controls organization access, docs scope, and analytics ownership
+
+### Environment examples
+
 - Vite: `VITE_FLUXYTE_API_KEY=pk_...`
 - Next.js: `NEXT_PUBLIC_FLUXYTE_API_KEY=pk_...` (public key only)
 - Server: `FLUXYTE_API_KEY=sk_...`
@@ -302,6 +331,24 @@ start({
 });
 ```
 
+```tsx
+import { useVoiceChat } from "@fluxyte/sdk/react";
+
+const { sendVoice, loading, data, error } = useVoiceChat();
+
+const res = await sendVoice({
+  audioBase64: "BASE64_AUDIO",
+  mimeType: "audio/webm",
+  context: { product: "analytics", userTarget: "admin" },
+  synthesize: true,
+  voice: "alloy",
+  audioFormat: "mp3",
+});
+
+console.log(res.transcript);
+console.log(res.reply);
+```
+
 ## Multi-Target
 
 Use `context.product` or `context.service` to isolate onboarding targets under one account (apps, APIs, and services).

package/dist/react/useVoiceChat.d.ts

@@ -10,6 +10,15 @@ export declare function useVoiceChat(): {
         audioFormat?: components["schemas"]["VoiceAudioFormat"] | null;
         replyAudioBase64?: string | null;
     }>;
+    sendVoice: (payload: VoiceChatRequest) => Promise<{
+        answerId: string;
+        transcript: string;
+        reply: string;
+        confidence?: number | null;
+        sources?: components["schemas"]["EvidenceItem"][];
+        audioFormat?: components["schemas"]["VoiceAudioFormat"] | null;
+        replyAudioBase64?: string | null;
+    }>;
     data: {
         answerId: string;
         transcript: string;

package/dist/react/useVoiceChat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useVoiceChat.d.ts","sourceRoot":"","sources":["../../src/react/useVoiceChat.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAGvD,KAAK,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAGlE,wBAAgB,YAAY;oBAOR,gBAAgB;;;;;kBAmBovI,qBAAsB;sBAAuC,qBAAsB;;;;;;;;kBAAnF,qBAAsB;sBAAuC,qBAAsB;;;;;EAD12I"}
+{"version":3,"file":"useVoiceChat.d.ts","sourceRoot":"","sources":["../../src/react/useVoiceChat.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAGvD,KAAK,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAGlE,wBAAgB,YAAY;oBAOR,gBAAgB;;;;;kBAuB2kI,qBAAsB;sBAAuC,qBAAsB;;;yBAvB9qI,gBAAgB;;;;;kBAuB2kI,qBAAsB;sBAAuC,qBAAsB;;;;;;;;kBAAnF,qBAAsB;sBAAuC,qBAAsB;;;;;EADjsI"}

package/dist/react/useVoiceChat.js

@@ -22,6 +22,9 @@ export function useVoiceChat() {
             setLoading(false);
         }
     }, [client]);
-    return { send, data, loading, error };
+    // Keep `send` for consistency with other hooks and expose `sendVoice`
+    // as an explicit alias for voice-focused integrations.
+    const sendVoice = send;
+    return { send, sendVoice, data, loading, error };
 }
 //# sourceMappingURL=useVoiceChat.js.map

package/dist/react/useVoiceChat.js.map

@@ -1 +1 @@
-{"version":3,"file":"useVoiceChat.js","sourceRoot":"","sources":["../../src/react/useVoiceChat.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAKlE,MAAM,UAAU,YAAY;IAC1B,MAAM,MAAM,GAAG,qBAAqB,EAAE,CAAC;IACvC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAA2B,IAAI,CAAC,CAAC;IACjE,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9C,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAe,IAAI,CAAC,CAAC;IAEvD,MAAM,IAAI,GAAG,WAAW,CACtB,KAAK,EAAE,OAAyB,EAAE,EAAE;QAClC,UAAU,CAAC,IAAI,CAAC,CAAC;QACjB,QAAQ,CAAC,IAAI,CAAC,CAAC;QACf,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAC5C,OAAO,CAAC,GAAG,CAAC,CAAC;YACb,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,QAAQ,CAAC,GAAY,CAAC,CAAC;YACvB,MAAM,GAAG,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,UAAU,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACH,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AACxC,CAAC"}
+{"version":3,"file":"useVoiceChat.js","sourceRoot":"","sources":["../../src/react/useVoiceChat.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAKlE,MAAM,UAAU,YAAY;IAC1B,MAAM,MAAM,GAAG,qBAAqB,EAAE,CAAC;IACvC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAA2B,IAAI,CAAC,CAAC;IACjE,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9C,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAe,IAAI,CAAC,CAAC;IAEvD,MAAM,IAAI,GAAG,WAAW,CACtB,KAAK,EAAE,OAAyB,EAAE,EAAE;QAClC,UAAU,CAAC,IAAI,CAAC,CAAC;QACjB,QAAQ,CAAC,IAAI,CAAC,CAAC;QACf,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAC5C,OAAO,CAAC,GAAG,CAAC,CAAC;YACb,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,QAAQ,CAAC,GAAY,CAAC,CAAC;YACvB,MAAM,GAAG,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,UAAU,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACH,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,sEAAsE;IACtE,uDAAuD;IACvD,MAAM,SAAS,GAAG,IAAI,CAAC;IAEvB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AACnD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluxyte/sdk",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Official Fluxyte SDK (TypeScript) for the Fluxyte Onboarding AI API",
   "license": "SEE LICENSE IN LICENSE.md",
   "type": "module",