supafone-labs 0.3.1 → 0.4.0

package/README.md

@@ -59,6 +59,21 @@ The default path is fully Supafone-managed. Developers do **not** need a Twilio
 account, Ultravox account, or voice-provider account to buy a number and launch
 an agent.
 
+Supafone Labs has two main features:
+
+- **Agent Factory**: create the complete hosted agent with managed provider
+  defaults and one Supafone API key.
+- **Self-healing watcher**: enable `labs.enabled` to attach the Supafone Labs
+  second mind to a hosted or BYOK agent.
+
+BYOK is advanced and split into three independent lanes:
+
+| Lane | Examples |
+| --- | --- |
+| Agent/provider stack | Ultravox, Retell, Vapi, Bland, LiveKit, Pipecat, GPT Realtime, Grok |
+| Telephony | Twilio, Telnyx, Plivo, SignalWire, SIP/custom trunks |
+| TTS | Cartesia, ElevenLabs, Inworld, Deepgram, custom TTS |
+
 ```ts
 import { Supafone } from "supafone-labs";
 
@@ -88,6 +103,21 @@ const inbound = await supafone.labs.agents.createInboundWithNumber({
     enabled: true,
     model: "gemma",
   },
+  recording: {
+    enabled: true,
+    recordAudio: true,
+    consentRequired: true,
+    announcement: "This call may be recorded for quality and training.",
+    retentionDays: 30,
+    redactPii: true,
+  },
+  transcription: {
+    enabled: true,
+    provider: "supafone_managed",
+    language: "multi",
+    diarization: true,
+    timestamps: true,
+  },
   tools: {
     callRouting: true,
     scheduling: true,
@@ -128,8 +158,16 @@ const outbound = await supafone.labs.agents.createOutboundWithNumber({
 console.log(outbound.number?.assignment);
 ```
 
+Call artifacts are available from the same hosted-agent namespace:
+
+```ts
+await supafone.labs.calls.list({ agentKey: "medivoice-intake" });
+await supafone.labs.recordings.list({ agentKey: "medivoice-intake" });
+await supafone.labs.transcripts.list({ agentKey: "medivoice-intake" });
+```
+
 If you already own telephony, keep Supafone's agent framework and configure
-BYOK as the advanced path:
+that BYOK lane as the advanced path:
 
 ```ts
 await supafone.labs.telephony.configure({
@@ -143,6 +181,40 @@ await supafone.labs.telephony.configure({
 });
 ```
 
+Or configure all three BYOK lanes in one agent payload:
+
+```ts
+await supafone.labs.agents.createOutbound({
+  agentKey: "speed-to-lead-byok",
+  name: "Speed to lead BYOK",
+  byok: {
+    agentProvider: {
+      provider: "ultravox",
+      apiKey: process.env.ULTRAVOX_API_KEY!,
+    },
+    telephony: {
+      mode: "byok",
+      provider: "telnyx",
+      credentials: {
+        apiKey: process.env.TELNYX_API_KEY!,
+        connectionId: process.env.TELNYX_CONNECTION_ID!,
+        fromNumber: "+14155550123",
+      },
+    },
+    tts: {
+      provider: "cartesia",
+      apiKey: process.env.CARTESIA_API_KEY!,
+    },
+  },
+  labs: {
+    enabled: true,
+    mode: "byok",
+    managedInfrastructure: false,
+    tts: { provider: "cartesia" },
+  },
+});
+```
+
 ## Verify the hosted-agent path
 
 Use the production smoke example before handing a key to a customer or testing a