@vellumai/plugin-api 0.10.7-dev.202607101252.74ea83d → 0.10.7-dev.202607101459.27388eb

package/index.d.ts

@@ -3882,6 +3882,7 @@ declare const messageMetadataSchema: z.ZodObject<{
         trusted_contact: "trusted_contact";
         unverified_contact: "unverified_contact";
     }>>;
+    model: z.ZodOptional<z.ZodString>;
     provenanceSourceChannel: z.ZodOptional<z.ZodEnum<{
         vellum: "vellum";
         telegram: "telegram";
@@ -5518,6 +5519,29 @@ declare type _SyncInvalidationServerMessages = SyncChangedEvent;
 /** Re-sync one persisted message into the conversation's disk view. */
 export declare function syncMessageToDisk(conversationId: string, messageId: string, createdAtMs: number): Promise<void>;
 
+/**
+ * Synthesize text to audio using the globally configured TTS provider.
+ *
+ * 1. Resolves the active provider and its config via `tts-config-resolver`.
+ * 2. Looks up the provider adapter in the registry.
+ * 3. Delegates to the adapter's `synthesize` method.
+ *
+ * Throws {@link TtsSynthesisError} when the provider is not registered
+ * or synthesis fails.
+ */
+export declare function synthesizeText(options: SynthesizeTextOptions): Promise<TtsSynthesisResult>;
+
+export declare interface SynthesizeTextOptions {
+    /** Text to speak. Sanitized internally — callers can pass raw model output. */
+    text: string;
+    /** Product surface requesting synthesis. */
+    useCase: TtsUseCase;
+    /** Optional voice override (provider-specific identifier). */
+    voiceId?: string;
+    /** Optional abort signal. */
+    signal?: AbortSignal;
+}
+
 declare interface TableCellValue {
     text: string;
     icon?: string;
@@ -6205,6 +6229,31 @@ declare const trustClassSchema: z.ZodEnum<{
     unverified_contact: "unverified_contact";
 }>;
 
+export declare class TtsSynthesisError extends Error {
+    readonly code: TtsSynthesisErrorCode;
+    constructor(code: TtsSynthesisErrorCode, message: string);
+}
+
+declare type TtsSynthesisErrorCode = "TTS_PROVIDER_NOT_CONFIGURED" | "TTS_SYNTHESIS_FAILED";
+
+/** Output of a completed TTS synthesis call. */
+export declare interface TtsSynthesisResult {
+    /** Complete audio buffer. */
+    audio: Buffer;
+    /** MIME type of the returned audio (e.g. `"audio/mpeg"`, `"audio/wav"`). */
+    contentType: string;
+}
+
+/**
+ * Describes the product surface that is requesting synthesis so providers
+ * can tailor format, latency, and quality trade-offs.
+ */
+declare type TtsUseCase = 
+/** Real-time phone call — prioritize low latency and streaming. */
+"phone-call"
+/** In-app message playback — buffer-oriented, higher quality acceptable. */
+| "message-playback";
+
 declare interface UiSurfaceComplete {
     type: "ui_surface_complete";
     conversationId: string;

package/index.js

@@ -3,6 +3,7 @@ const api = globalThis[Symbol.for("vellum.plugin-api")] ?? {};
 export const CLI_COMMAND_HELP = api.CLI_COMMAND_HELP;
 export const HOOKS = api.HOOKS;
 export const RiskLevel = api.RiskLevel;
+export const TtsSynthesisError = api.TtsSynthesisError;
 export const addMessage = api.addMessage;
 export const assistantEventHub = api.assistantEventHub;
 export const buildMessageExcerpt = api.buildMessageExcerpt;
@@ -29,4 +30,5 @@ export const searchMessageIdsLexical = api.searchMessageIdsLexical;
 export const selectedBackendSupportsMultimodal = api.selectedBackendSupportsMultimodal;
 export const stringifyMessageContent = api.stringifyMessageContent;
 export const syncMessageToDisk = api.syncMessageToDisk;
+export const synthesizeText = api.synthesizeText;
 export const updateMessageMetadata = api.updateMessageMetadata;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vellumai/plugin-api",
-  "version": "0.10.7-dev.202607101252.74ea83d",
+  "version": "0.10.7-dev.202607101459.27388eb",
   "description": "Public TypeScript authoring contract for Vellum assistant plugins.",
   "license": "MIT",
   "type": "module",