@voicelayer/sdk 0.1.3 → 0.1.4

package/README.md

@@ -201,6 +201,49 @@ interfaces directly.
 
 ---
 
+## Bring your own LLM
+
+Don't want a first-party model at all? Bring your own brain — your existing agent, a private model, a LangChain app, anything. VoiceLayer keeps doing STT, TTS, turn-taking, and telephony; your code does the thinking. Three ways, smallest first.
+
+**1. An in-process function** — your existing agent as a callback (the "two lines" path):
+
+```ts
+import { defineAgent } from '@voicelayer/sdk';
+
+export default await defineAgent({
+  name: 'support',
+  prompt: 'bridged to my brain',
+  onQuery: async (text) => myExistingAgent.reply(text),  // ← your brain
+}).start(import.meta.url);
+```
+
+`onQuery` gets the caller's final transcript and returns the reply — a `string`, or an `AsyncIterable<string>` to stream tokens (the SDK speaks the first sentence as soon as it lands). STT, TTS, and barge-in stay ours.
+
+**2. A direct endpoint** — point at any public OpenAI-compatible URL:
+
+```ts
+import { defineAgent, connector } from '@voicelayer/sdk';
+
+export default await defineAgent({
+  name: 'support',
+  prompt: 'You are a helpful assistant. Keep replies short.',
+  models: {
+    llm: connector.llm({
+      url: 'https://your-brain.example.com/v1',   // OpenAI-compatible
+      apiKey: process.env.BRAIN_API_KEY,
+      model: 'your-model',
+      fallbackText: 'Sorry, let me try that again.',
+    }),
+  },
+}).start(import.meta.url);
+```
+
+Works with OpenAI, Azure, Together, Groq, vLLM, or a [LiteLLM](https://docs.litellm.ai) proxy in front of anything. The URL is `https`-only and SSRF-guarded; under the hood it reuses the proven LiveKit OpenAI client.
+
+**3. A private endpoint (tunnel)** — keep your brain behind your firewall. Run the one-container `vl-brain` daemon — it dials *out* to us (no inbound ports) and LiteLLM is baked in to normalize any provider. The connector then shows up as a voice agent in the dashboard (its LLM is your brain; STT/TTS still swappable) — test it in the Playground, attach a number. No SDK code required. See the [`vl-brain` daemon guide](../../apps/connector-daemon/README.md).
+
+---
+
 ## Connectors
 
 Connectors are **typed integrations** with external systems. They show up on `ctx.connectors` and (optionally) as LLM tools.