nixflex 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.5.0
+
+- New: `client.llm` - bring your own OpenAI-compatible model (set() verifies with a real completion + tool-calling probe, key write-only). Calls it serves bill at -0.015/min.
+- New: `client.tts` - bring your own voice (elevenlabs/cartesia, set() verifies with a real synthesis, key write-only). Phone calls only; -0.02/min.
+- Docs: https://docs.nixflex.com/advanced/your-own-llm and /advanced/your-own-tts
+
 ## 0.4.0
 
 - New: `client.storage` - connect your own S3-compatible bucket for call recordings (data residency). `storage.set()` verifies with a probe write before saving, `storage.get()` never returns the secret, `storage.delete()` disconnects. Recordings then upload to your bucket and `recording_url` becomes a `byo:` path. See https://docs.nixflex.com/advanced/your-own-storage

package/dist/index.cjs

@@ -487,6 +487,49 @@ var Storage = class {
     return this.http.request("DELETE", "/account/storage", void 0, void 0, opts);
   }
 };
+var Llm = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Connect an OpenAI-compatible model. Verified BEFORE saving with a real
+   * completion + a tool-calling round trip (models without tool calling are
+   * refused). Calls your model serves bill at a $0.015/min discount; if it
+   * fails on a call the standard stack takes over and that call bills standard. */
+  set(params, opts) {
+    return this.http.request("PUT", "/account/llm", params, void 0, opts);
+  }
+  /** Current LLM configuration. The provider key is never included. */
+  get(opts) {
+    return this.http.request("GET", "/account/llm", void 0, void 0, opts);
+  }
+  /** Disconnect. Calls return to the standard stack and rate from the next call. */
+  delete(opts) {
+    return this.http.request("DELETE", "/account/llm", void 0, void 0, opts);
+  }
+};
+var Tts = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Connect your voice provider (elevenlabs or cartesia). Verified BEFORE
+   * saving with one real synthesis using the exact voice ID. Phone calls only -
+   * web calls keep the standard voice. Calls your voice serves bill at a
+   * $0.02/min discount; on failure the standard voice takes over and that call
+   * bills the standard TTS rate. */
+  set(params, opts) {
+    return this.http.request("PUT", "/account/tts", params, void 0, opts);
+  }
+  /** Current TTS configuration. The provider key is never included. */
+  get(opts) {
+    return this.http.request("GET", "/account/tts", void 0, void 0, opts);
+  }
+  /** Disconnect. Calls return to the standard voice and rate from the next call. */
+  delete(opts) {
+    return this.http.request("DELETE", "/account/tts", void 0, void 0, opts);
+  }
+};
 var Webhooks = class {
   constructor(http) {
     this.http = http;
@@ -536,6 +579,10 @@ var Nixflex = class {
   webhooks;
   /** Your own S3-compatible recording storage (data residency). */
   storage;
+  /** Your own LLM (OpenAI-compatible endpoint, verified with tool-calling probe). */
+  llm;
+  /** Your own TTS (elevenlabs/cartesia, verified with a real synthesis). */
+  tts;
   constructor(options) {
     const http = new HttpClient(options);
     this.agents = new Agents(http);
@@ -547,6 +594,8 @@ var Nixflex = class {
     this.usage = new UsageResource(http);
     this.webhooks = new Webhooks(http);
     this.storage = new Storage(http);
+    this.llm = new Llm(http);
+    this.tts = new Tts(http);
   }
   /** Create a brand-new API key (unauthenticated signup endpoint - most
    * developers use the dashboard instead). The key_secret is shown ONCE.

package/dist/index.d.cts

@@ -608,6 +608,57 @@ interface StorageDeleteResponse {
     ok: boolean;
     storage_enabled: boolean;
 }
+/** Your own LLM (BYO LLM) - an OpenAI-compatible endpoint answers every call. */
+interface LlmConfig {
+    byo_llm_enabled: boolean;
+    endpoint: string | null;
+    model: string | null;
+}
+interface LlmSetParams {
+    /** OpenAI-compatible https:// base URL, e.g. https://api.openai.com/v1 */
+    endpoint: string;
+    /** Model name as your provider knows it. Must support OpenAI-style tool calling. */
+    model: string;
+    /** Your provider API key. Write-only - stored encrypted, never returned. */
+    api_key: string;
+}
+interface LlmSetResponse {
+    ok: boolean;
+    byo_llm_enabled: boolean;
+    endpoint: string;
+    model: string;
+    verified: boolean;
+}
+interface LlmDeleteResponse {
+    ok: boolean;
+    byo_llm_enabled: boolean;
+}
+/** Your own TTS (BYO TTS) - your voice provider speaks on every phone call. */
+type TtsProvider = 'elevenlabs' | 'cartesia';
+interface TtsConfig {
+    byo_tts_enabled: boolean;
+    provider: TtsProvider | null;
+    voice_id: string | null;
+}
+interface TtsSetParams {
+    /** 'elevenlabs' or 'cartesia'. */
+    provider: TtsProvider;
+    /** Voice ID exactly as shown in your provider console. */
+    voice_id: string;
+    /** Your provider API key. Write-only - stored encrypted, never returned. */
+    api_key: string;
+}
+interface TtsSetResponse {
+    ok: boolean;
+    byo_tts_enabled: boolean;
+    provider: TtsProvider;
+    voice_id: string;
+    verified: boolean;
+}
+interface TtsDeleteResponse {
+    ok: boolean;
+    byo_tts_enabled: boolean;
+}
 
 declare class PhoneNumbers {
     private readonly http;
@@ -710,6 +761,34 @@ declare class Storage {
     delete(opts?: RequestOptions): Promise<StorageDeleteResponse>;
 }
 
+declare class Llm {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Connect an OpenAI-compatible model. Verified BEFORE saving with a real
+     * completion + a tool-calling round trip (models without tool calling are
+     * refused). Calls your model serves bill at a $0.015/min discount; if it
+     * fails on a call the standard stack takes over and that call bills standard. */
+    set(params: LlmSetParams, opts?: RequestOptions): Promise<LlmSetResponse>;
+    /** Current LLM configuration. The provider key is never included. */
+    get(opts?: RequestOptions): Promise<LlmConfig>;
+    /** Disconnect. Calls return to the standard stack and rate from the next call. */
+    delete(opts?: RequestOptions): Promise<LlmDeleteResponse>;
+}
+declare class Tts {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Connect your voice provider (elevenlabs or cartesia). Verified BEFORE
+     * saving with one real synthesis using the exact voice ID. Phone calls only -
+     * web calls keep the standard voice. Calls your voice serves bill at a
+     * $0.02/min discount; on failure the standard voice takes over and that call
+     * bills the standard TTS rate. */
+    set(params: TtsSetParams, opts?: RequestOptions): Promise<TtsSetResponse>;
+    /** Current TTS configuration. The provider key is never included. */
+    get(opts?: RequestOptions): Promise<TtsConfig>;
+    /** Disconnect. Calls return to the standard voice and rate from the next call. */
+    delete(opts?: RequestOptions): Promise<TtsDeleteResponse>;
+}
+
 declare class Webhooks {
     private readonly http;
     constructor(http: HttpClient);
@@ -801,6 +880,10 @@ declare class Nixflex {
     readonly webhooks: Webhooks;
     /** Your own S3-compatible recording storage (data residency). */
     readonly storage: Storage;
+    /** Your own LLM (OpenAI-compatible endpoint, verified with tool-calling probe). */
+    readonly llm: Llm;
+    /** Your own TTS (elevenlabs/cartesia, verified with a real synthesis). */
+    readonly tts: Tts;
     constructor(options: NixflexClientOptions);
     /** Create a brand-new API key (unauthenticated signup endpoint - most
      * developers use the dashboard instead). The key_secret is shown ONCE.
@@ -811,4 +894,4 @@ declare class Nixflex {
     }, baseUrl?: string): Promise<KeyCreateResponse>;
 }
 
-export { type Agent, type AgentCreateParams, type AgentDeleteResponse, type AgentUpdateParams, type BatchCampaignParams, type BatchCreateResponse, type BatchInvalidEntry, type BatchLaunchResponse, type BatchRecipient, type Call, type CallDeleteAllResponse, type CallDeleteResponse, type CallDirection, type CallerSentiment, type KeyCreateResponse, type KeyRotateResponse, type ListParams, type MonitorToggleResponse, Nixflex, type NixflexAPIErrorBody, NixflexAuthenticationError, type NixflexClientOptions, NixflexConnectionError, NixflexError, NixflexInvalidRequestError, NixflexNotFoundError, NixflexPaymentRequiredError, NixflexRateLimitError, NixflexServerError, type OutboundCallParams, type OutboundCallResponse, type PhoneNumber, type PhoneNumberDeleteResponse, type PhoneNumberImportParams, type PhoneNumberListResponse, type PhoneNumberUpdateParams, type RequestOptions, type ResponseLength, type SmsCampaign, type SmsCampaignCreateParams, type SmsCampaignDeleteResponse, type SmsCampaignLaunchResponse, type SmsCampaignListResponse, type SmsCampaignRecipient, type SmsCampaignStatus, type SmsSendParams, type SmsSendResponse, type StorageConfig, type StorageDeleteResponse, type StorageSetParams, type StorageSetResponse, type TransferType, type Usage, type VerifyOptions, type WebCallsToggleResponse, type WebhookConfigResponse, type Weekday, Nixflex as default, errorFromResponse, verifyWebhookSignature };
+export { type Agent, type AgentCreateParams, type AgentDeleteResponse, type AgentUpdateParams, type BatchCampaignParams, type BatchCreateResponse, type BatchInvalidEntry, type BatchLaunchResponse, type BatchRecipient, type Call, type CallDeleteAllResponse, type CallDeleteResponse, type CallDirection, type CallerSentiment, type KeyCreateResponse, type KeyRotateResponse, type ListParams, type LlmConfig, type LlmDeleteResponse, type LlmSetParams, type LlmSetResponse, type MonitorToggleResponse, Nixflex, type NixflexAPIErrorBody, NixflexAuthenticationError, type NixflexClientOptions, NixflexConnectionError, NixflexError, NixflexInvalidRequestError, NixflexNotFoundError, NixflexPaymentRequiredError, NixflexRateLimitError, NixflexServerError, type OutboundCallParams, type OutboundCallResponse, type PhoneNumber, type PhoneNumberDeleteResponse, type PhoneNumberImportParams, type PhoneNumberListResponse, type PhoneNumberUpdateParams, type RequestOptions, type ResponseLength, type SmsCampaign, type SmsCampaignCreateParams, type SmsCampaignDeleteResponse, type SmsCampaignLaunchResponse, type SmsCampaignListResponse, type SmsCampaignRecipient, type SmsCampaignStatus, type SmsSendParams, type SmsSendResponse, type StorageConfig, type StorageDeleteResponse, type StorageSetParams, type StorageSetResponse, type TransferType, type TtsConfig, type TtsDeleteResponse, type TtsProvider, type TtsSetParams, type TtsSetResponse, type Usage, type VerifyOptions, type WebCallsToggleResponse, type WebhookConfigResponse, type Weekday, Nixflex as default, errorFromResponse, verifyWebhookSignature };

package/dist/index.d.ts

@@ -608,6 +608,57 @@ interface StorageDeleteResponse {
     ok: boolean;
     storage_enabled: boolean;
 }
+/** Your own LLM (BYO LLM) - an OpenAI-compatible endpoint answers every call. */
+interface LlmConfig {
+    byo_llm_enabled: boolean;
+    endpoint: string | null;
+    model: string | null;
+}
+interface LlmSetParams {
+    /** OpenAI-compatible https:// base URL, e.g. https://api.openai.com/v1 */
+    endpoint: string;
+    /** Model name as your provider knows it. Must support OpenAI-style tool calling. */
+    model: string;
+    /** Your provider API key. Write-only - stored encrypted, never returned. */
+    api_key: string;
+}
+interface LlmSetResponse {
+    ok: boolean;
+    byo_llm_enabled: boolean;
+    endpoint: string;
+    model: string;
+    verified: boolean;
+}
+interface LlmDeleteResponse {
+    ok: boolean;
+    byo_llm_enabled: boolean;
+}
+/** Your own TTS (BYO TTS) - your voice provider speaks on every phone call. */
+type TtsProvider = 'elevenlabs' | 'cartesia';
+interface TtsConfig {
+    byo_tts_enabled: boolean;
+    provider: TtsProvider | null;
+    voice_id: string | null;
+}
+interface TtsSetParams {
+    /** 'elevenlabs' or 'cartesia'. */
+    provider: TtsProvider;
+    /** Voice ID exactly as shown in your provider console. */
+    voice_id: string;
+    /** Your provider API key. Write-only - stored encrypted, never returned. */
+    api_key: string;
+}
+interface TtsSetResponse {
+    ok: boolean;
+    byo_tts_enabled: boolean;
+    provider: TtsProvider;
+    voice_id: string;
+    verified: boolean;
+}
+interface TtsDeleteResponse {
+    ok: boolean;
+    byo_tts_enabled: boolean;
+}
 
 declare class PhoneNumbers {
     private readonly http;
@@ -710,6 +761,34 @@ declare class Storage {
     delete(opts?: RequestOptions): Promise<StorageDeleteResponse>;
 }
 
+declare class Llm {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Connect an OpenAI-compatible model. Verified BEFORE saving with a real
+     * completion + a tool-calling round trip (models without tool calling are
+     * refused). Calls your model serves bill at a $0.015/min discount; if it
+     * fails on a call the standard stack takes over and that call bills standard. */
+    set(params: LlmSetParams, opts?: RequestOptions): Promise<LlmSetResponse>;
+    /** Current LLM configuration. The provider key is never included. */
+    get(opts?: RequestOptions): Promise<LlmConfig>;
+    /** Disconnect. Calls return to the standard stack and rate from the next call. */
+    delete(opts?: RequestOptions): Promise<LlmDeleteResponse>;
+}
+declare class Tts {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Connect your voice provider (elevenlabs or cartesia). Verified BEFORE
+     * saving with one real synthesis using the exact voice ID. Phone calls only -
+     * web calls keep the standard voice. Calls your voice serves bill at a
+     * $0.02/min discount; on failure the standard voice takes over and that call
+     * bills the standard TTS rate. */
+    set(params: TtsSetParams, opts?: RequestOptions): Promise<TtsSetResponse>;
+    /** Current TTS configuration. The provider key is never included. */
+    get(opts?: RequestOptions): Promise<TtsConfig>;
+    /** Disconnect. Calls return to the standard voice and rate from the next call. */
+    delete(opts?: RequestOptions): Promise<TtsDeleteResponse>;
+}
+
 declare class Webhooks {
     private readonly http;
     constructor(http: HttpClient);
@@ -801,6 +880,10 @@ declare class Nixflex {
     readonly webhooks: Webhooks;
     /** Your own S3-compatible recording storage (data residency). */
     readonly storage: Storage;
+    /** Your own LLM (OpenAI-compatible endpoint, verified with tool-calling probe). */
+    readonly llm: Llm;
+    /** Your own TTS (elevenlabs/cartesia, verified with a real synthesis). */
+    readonly tts: Tts;
     constructor(options: NixflexClientOptions);
     /** Create a brand-new API key (unauthenticated signup endpoint - most
      * developers use the dashboard instead). The key_secret is shown ONCE.
@@ -811,4 +894,4 @@ declare class Nixflex {
     }, baseUrl?: string): Promise<KeyCreateResponse>;
 }
 
-export { type Agent, type AgentCreateParams, type AgentDeleteResponse, type AgentUpdateParams, type BatchCampaignParams, type BatchCreateResponse, type BatchInvalidEntry, type BatchLaunchResponse, type BatchRecipient, type Call, type CallDeleteAllResponse, type CallDeleteResponse, type CallDirection, type CallerSentiment, type KeyCreateResponse, type KeyRotateResponse, type ListParams, type MonitorToggleResponse, Nixflex, type NixflexAPIErrorBody, NixflexAuthenticationError, type NixflexClientOptions, NixflexConnectionError, NixflexError, NixflexInvalidRequestError, NixflexNotFoundError, NixflexPaymentRequiredError, NixflexRateLimitError, NixflexServerError, type OutboundCallParams, type OutboundCallResponse, type PhoneNumber, type PhoneNumberDeleteResponse, type PhoneNumberImportParams, type PhoneNumberListResponse, type PhoneNumberUpdateParams, type RequestOptions, type ResponseLength, type SmsCampaign, type SmsCampaignCreateParams, type SmsCampaignDeleteResponse, type SmsCampaignLaunchResponse, type SmsCampaignListResponse, type SmsCampaignRecipient, type SmsCampaignStatus, type SmsSendParams, type SmsSendResponse, type StorageConfig, type StorageDeleteResponse, type StorageSetParams, type StorageSetResponse, type TransferType, type Usage, type VerifyOptions, type WebCallsToggleResponse, type WebhookConfigResponse, type Weekday, Nixflex as default, errorFromResponse, verifyWebhookSignature };
+export { type Agent, type AgentCreateParams, type AgentDeleteResponse, type AgentUpdateParams, type BatchCampaignParams, type BatchCreateResponse, type BatchInvalidEntry, type BatchLaunchResponse, type BatchRecipient, type Call, type CallDeleteAllResponse, type CallDeleteResponse, type CallDirection, type CallerSentiment, type KeyCreateResponse, type KeyRotateResponse, type ListParams, type LlmConfig, type LlmDeleteResponse, type LlmSetParams, type LlmSetResponse, type MonitorToggleResponse, Nixflex, type NixflexAPIErrorBody, NixflexAuthenticationError, type NixflexClientOptions, NixflexConnectionError, NixflexError, NixflexInvalidRequestError, NixflexNotFoundError, NixflexPaymentRequiredError, NixflexRateLimitError, NixflexServerError, type OutboundCallParams, type OutboundCallResponse, type PhoneNumber, type PhoneNumberDeleteResponse, type PhoneNumberImportParams, type PhoneNumberListResponse, type PhoneNumberUpdateParams, type RequestOptions, type ResponseLength, type SmsCampaign, type SmsCampaignCreateParams, type SmsCampaignDeleteResponse, type SmsCampaignLaunchResponse, type SmsCampaignListResponse, type SmsCampaignRecipient, type SmsCampaignStatus, type SmsSendParams, type SmsSendResponse, type StorageConfig, type StorageDeleteResponse, type StorageSetParams, type StorageSetResponse, type TransferType, type TtsConfig, type TtsDeleteResponse, type TtsProvider, type TtsSetParams, type TtsSetResponse, type Usage, type VerifyOptions, type WebCallsToggleResponse, type WebhookConfigResponse, type Weekday, Nixflex as default, errorFromResponse, verifyWebhookSignature };

package/dist/index.js

@@ -451,6 +451,49 @@ var Storage = class {
     return this.http.request("DELETE", "/account/storage", void 0, void 0, opts);
   }
 };
+var Llm = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Connect an OpenAI-compatible model. Verified BEFORE saving with a real
+   * completion + a tool-calling round trip (models without tool calling are
+   * refused). Calls your model serves bill at a $0.015/min discount; if it
+   * fails on a call the standard stack takes over and that call bills standard. */
+  set(params, opts) {
+    return this.http.request("PUT", "/account/llm", params, void 0, opts);
+  }
+  /** Current LLM configuration. The provider key is never included. */
+  get(opts) {
+    return this.http.request("GET", "/account/llm", void 0, void 0, opts);
+  }
+  /** Disconnect. Calls return to the standard stack and rate from the next call. */
+  delete(opts) {
+    return this.http.request("DELETE", "/account/llm", void 0, void 0, opts);
+  }
+};
+var Tts = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Connect your voice provider (elevenlabs or cartesia). Verified BEFORE
+   * saving with one real synthesis using the exact voice ID. Phone calls only -
+   * web calls keep the standard voice. Calls your voice serves bill at a
+   * $0.02/min discount; on failure the standard voice takes over and that call
+   * bills the standard TTS rate. */
+  set(params, opts) {
+    return this.http.request("PUT", "/account/tts", params, void 0, opts);
+  }
+  /** Current TTS configuration. The provider key is never included. */
+  get(opts) {
+    return this.http.request("GET", "/account/tts", void 0, void 0, opts);
+  }
+  /** Disconnect. Calls return to the standard voice and rate from the next call. */
+  delete(opts) {
+    return this.http.request("DELETE", "/account/tts", void 0, void 0, opts);
+  }
+};
 var Webhooks = class {
   constructor(http) {
     this.http = http;
@@ -500,6 +543,10 @@ var Nixflex = class {
   webhooks;
   /** Your own S3-compatible recording storage (data residency). */
   storage;
+  /** Your own LLM (OpenAI-compatible endpoint, verified with tool-calling probe). */
+  llm;
+  /** Your own TTS (elevenlabs/cartesia, verified with a real synthesis). */
+  tts;
   constructor(options) {
     const http = new HttpClient(options);
     this.agents = new Agents(http);
@@ -511,6 +558,8 @@ var Nixflex = class {
     this.usage = new UsageResource(http);
     this.webhooks = new Webhooks(http);
     this.storage = new Storage(http);
+    this.llm = new Llm(http);
+    this.tts = new Tts(http);
   }
   /** Create a brand-new API key (unauthenticated signup endpoint - most
    * developers use the dashboard instead). The key_secret is shown ONCE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nixflex",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Official Node.js SDK for the Nixflex voice AI platform - AI phone agents, outbound campaigns, and SMS.",
   "keywords": [
     "nixflex",