@soniox/tanstack-ai-adapter

@soniox/tanstack-ai-adapter

TanStack AI adapter for Soniox transcription models. This adapter integrates Soniox speech-to-text capabilities with TanStack AI's transcription API.

Installation

npm install @soniox/tanstack-ai-adapter

Authentication

Set SONIOX_API_KEY in your environment or pass apiKey when creating the adapter. Get your API key from the Soniox Console.

Example

import { generateTranscription } from '@tanstack/ai'
import { sonioxTranscription } from '@soniox/tanstack-ai-adapter'

const result = await generateTranscription({
  adapter: sonioxTranscription('stt-async-v4'),
  audio: audioFile,
  modelOptions: {
    enableLanguageIdentification: true,
    enableSpeakerDiarization: true,
  },
})

console.log(result.text)
console.log(result.segments) // Timestamped segments with speaker info

Adapter configuration

Use createSonioxTranscription to customize the adapter instance:

import { createSonioxTranscription } from '@soniox/tanstack-ai-adapter'

const adapter = createSonioxTranscription('stt-async-v4', process.env.SONIOX_API_KEY!, {
  baseUrl: 'https://api.soniox.com',
  pollingIntervalMs: 1000,
  timeout: 180000,
  headers: {
    'Custom-Header': 'value',
  },
})

Options:

• apiKey: override SONIOX_API_KEY (required when using createSonioxTranscription).
• baseUrl: custom API base URL. See list of regional API endpoints here. Default is https://api.soniox.com.
• headers: additional request headers.
• timeout: transcription timeout in milliseconds. Default is 180000ms (3 minutes).
• pollingIntervalMs: transcription polling interval in milliseconds. Default is 1000ms.

Transcription options

Per-request options are passed via modelOptions:

const result = await generateTranscription({
  adapter: sonioxTranscription('stt-async-v4'),
  audio,
  modelOptions: {
    languageHints: ['en', 'es'],
    enableLanguageIdentification: true,
    enableSpeakerDiarization: true,
    context: {
      terms: ['Soniox', 'TanStack'],
    },
  },
})

Available options:

• languageHints - Array of ISO language codes to bias recognition
• languageHintsStrict - When true, rely more heavily on language hints (note: not supported by all models)
• enableLanguageIdentification - Automatically detect spoken language
• enableSpeakerDiarization - Identify and separate different speakers
• context - Additional context to improve accuracy (see Context section)
• clientReferenceId - Optional client-defined reference ID
• webhookUrl - Webhook URL for transcription completion notifications
• webhookAuthHeaderName - Webhook authentication header name
• webhookAuthHeaderValue - Webhook authentication header value
• translation - Translation configuration (see Translation section)

Check the Soniox API reference for more details.

Language hints

Soniox automatically detects and transcribes speech in 60+ languages. When you know which languages are likely to appear in your audio, provide languageHints to improve accuracy by biasing recognition toward those languages.

Language hints do not restrict recognition — they only bias the model toward the specified languages, while still allowing other languages to be detected if present.

If you pass the TanStack language option, this adapter will merge it into languageHints for convenience.

const result = await generateTranscription({
  adapter: sonioxTranscription('stt-async-v4'),
  audio,
  modelOptions: {
    languageHints: ['en', 'es'], // ISO language codes
  },
})

For more details, see the Soniox language hints documentation.

Context

Provide custom context to improve transcription and translation accuracy. Context helps the model understand your domain, recognize important terms, and apply custom vocabulary.

The context object supports four optional sections:

const result = await generateTranscription({
  adapter: sonioxTranscription('stt-async-v4'),
  audio,
  modelOptions: {
    context: {
      // Structured key-value information (domain, topic, intent, etc.)
      general: [
        { key: 'domain', value: 'Healthcare' },
        { key: 'topic', value: 'Diabetes management consultation' },
        { key: 'doctor', value: 'Dr. Martha Smith' },
      ],
      // Longer free-form background text or related documents
      text: 'The patient has a history of...',
      // Domain-specific or uncommon words
      terms: ['Celebrex', 'Zyrtec', 'Xanax'],
      // Custom translations for ambiguous terms
      translationTerms: [
        { source: 'Mr. Smith', target: 'Sr. Smith' },
        { source: 'MRI', target: 'RM' },
      ],
    },
  },
})

For more details, see the Soniox context documentation.

Translation

Configure translation for your transcriptions:

const result = await generateTranscription({
  adapter: sonioxTranscription('stt-async-v4'),
  audio,
  modelOptions: {
    translation: {
      type: 'one_way',
      targetLanguage: 'es', // Translate to Spanish
    },
  },
})

// Or for two-way translation:
modelOptions: {
  translation: {
    type: 'two_way',
    languageA: 'en',
    languageB: 'es',
  },
}

Note: When using translation, the API returns both transcription tokens (original) and translation tokens. The segments array always includes only transcription tokens. To access translation tokens, use the providerMetadata field (see Accessing raw tokens section below) and filter by translation_status === 'translation'.

Response format

The generateTranscription function returns a TranscriptionResult object:

{
  id: string
  model: string
  text: string // Full transcription text
  language?: string // Detected language
  duration?: number // Audio duration in seconds
  segments?: Array<{
    id: number
    start: number // Start time in seconds
    end: number // End time in seconds
    text: string
    confidence?: number // Confidence score (0-1)
    speaker?: string // Speaker identifier (if diarization enabled)
  }>
}

Accessing raw tokens

When using translation or working with multilingual audio, you may need access to raw tokens with per-token language information and translation status. The adapter attaches a non-standard providerMetadata field at runtime:

const result = await generateTranscription({
  adapter: sonioxTranscription('stt-async-v4'),
  audio,
  modelOptions: {
    translation: { type: 'one_way', targetLanguage: 'es' },
  },
})

// Access raw Soniox tokens with full metadata
const rawTokens = (result as any).providerMetadata?.soniox?.tokens

if (rawTokens) {
  rawTokens.forEach((token) => {
    // token.text - token text
    // token.start_ms - start time in milliseconds
    // token.end_ms - end time in milliseconds
    // token.language - detected language for this token
    // token.translation_status - translation status (if translation enabled)
    // token.speaker - speaker identifier
    // token.confidence - confidence score
  })
}

Documentation

• Soniox API docs: https://soniox.com/docs
• TanStack AI docs: https://tanstack.com/ai