Skip to main content

📚 API Reference

runTranscription(config: TranscriptionConfig)​

Runs transcription on a local file path or remote URL.

Parameters:

  • config — Configuration object of type TranscriptionConfig

Returns: Promise<RunTranscriptionResult>

type RunTranscriptionResult = {
success: boolean;
transcription?: string;
error?: string;
};

runTranscriptionWithBlob(audioBlob: Blob | Buffer, options?)​

Runs transcription on an in-memory Blob (browser) or Node.js Buffer.

Parameters:

  • audioBlob — Blob or Buffer containing audio data
  • options — Optional config object with transcription options similar to TranscriptionConfig

Returns: Promise<RunTranscriptionResult>