xAI

OverviewCopy Anchor Link

• XAITTSService: streams text over a WebSocket and pushes audio as it arrives, with word timestamps from xAI's character timings.
• XAIHttpTTSService: one HTTP request per sentence.

InstallationCopy Anchor Link

bun add @pipedog/xai

import { XAITTSService, XAIHttpTTSService } from "@pipedog/xai/tts";

PrerequisitesCopy Anchor Link

• An xAI account and an API key from the xAI console.
• Pass the key as apiKey. The examples read it from XAI_API_KEY.

XAITTSServiceCopy Anchor Link

Connects to wss://api.x.ai/v1/tts.

ConfigurationCopy Anchor Link

SettingsCopy Anchor Link

Runtime-updatable settings, passed as settings: new XAITTSService.Settings({...}) (XAIWebsocketTTSSettings). Any setting you leave out keeps the default below.

UsageCopy Anchor Link

import { TTSUpdateSettingsFrame } from "@pipedog/core/frames/frames";
import { XAIHttpTTSService, XAITTSService } from "@pipedog/xai/tts";

const tts = new XAITTSService({
  apiKey: process.env.XAI_API_KEY ?? "",
  settings: new XAITTSService.Settings({ voice: "eve" }),
});

Change settings mid-call with an TTSUpdateSettingsFrame:

// Queue it on the worker, or push it from a processor upstream of the service.
const update = new TTSUpdateSettingsFrame({
  delta: new XAITTSService.Settings({ speed: 1.1 }),
});

Event handlersCopy Anchor Link

NotesCopy Anchor Link

• codec is "pcm" by default; wav, mulaw and alaw also work.
• The end of a turn sends text.done; an interruption sends text.clear and keeps the socket open.
• Settings are query parameters of the connection, so any settings change reconnects.

XAIHttpTTSServiceCopy Anchor Link

Posts each sentence to https://api.x.ai/v1/tts.

ConfigurationCopy Anchor Link

SettingsCopy Anchor Link

Runtime-updatable settings, passed as settings: new XAIHttpTTSService.Settings({...}) (XAITTSSettings). Any setting you leave out keeps the default below.

UsageCopy Anchor Link

const xAIHttpTTSService = new XAIHttpTTSService({
  apiKey: process.env.XAI_API_KEY ?? "",
  settings: new XAIHttpTTSService.Settings({ voice: "eve" }),
});

NotesCopy Anchor Link

• fetch replaces the global fetch (upstream takes an aiohttp session).
• encoding is "pcm" by default.

Runtime notesCopy Anchor Link

Generated from pipecat.runtimes and pipecat.compat in packages/xai/package.json: ✅ means the compat smoke test passes on that runtime.

• HTTP goes through fetch and the WebSocket through the core websocketConnect. Both work on Bun, Node, Deno and Cloudflare Workers.
• Tested against local servers, as upstream's tests do, not against xAI itself.