Skip to main content

Speechmatics Real-Time API Client

PyPI PythonSupport

Async Python client for the Speechmatics Real-Time API.

Features

  • Async-first design with simpler interface
  • Multi-channel transcription - Simultaneous processing of multiple audio sources
  • Single-stream transcription - Optimized client for single audio source
  • Comprehensive error handling with detailed error messages
  • Type hints throughout for excellent IDE support and code safety
  • Environment variable support for secure credential management
  • Event-driven architecture for real-time transcript processing
  • Simple connection management with clear error reporting

Installation

pip install speechmatics-rt

Quick Start

import asyncio
from speechmatics.rt import AsyncClient, ServerMessageType


async def main():
    # Create a client using environment variable SPEECHMATICS_API_KEY
    async with AsyncClient() as client:
        # Register event handlers
        @client.on(ServerMessageType.ADD_TRANSCRIPT)
        def handle_final_transcript(msg):
            print(f"Final: {msg['metadata']['transcript']}")

        # Transcribe audio file
        with open("audio.wav", "rb") as audio_file:
            await client.transcribe(audio_file)

# Run the async function
asyncio.run(main())

Multi-Channel Transcription

import asyncio
from speechmatics.rt import AsyncMultiChannelClient, ServerMessageType, TranscriptionConfig

async def main():
    # Prepare multiple audio sources
    sources = {
        "left": open("left.wav", "rb"),
        "right": open("right.wav", "rb"),
    }

    try:
        async with AsyncMultiChannelClient() as client:
            # Handle transcripts with channel identification
            @client.on(ServerMessageType.ADD_TRANSCRIPT)
            def handle_transcript(msg):
                channel = msg["results"][0]["channel"]
                transcript = msg["metadata"]["transcript"]
                print(f"[{channel}]: {transcript}")

            # Start multi-channel transcription
            await client.transcribe(
                sources,
                transcription_config=TranscriptionConfig(
                    language="en",
                    diarization="channel",
                    channel_diarization_labels=list(sources.keys()),
                )
            )
    finally:
        # Ensure all files are closed
        for source in sources.values():
            source.close()

asyncio.run(main())

JWT Authentication

For enhanced security, use temporary JWT tokens instead of static API keys. JWTs are short-lived (60 seconds by default).

from speechmatics.rt import AsyncClient, JWTAuth

# Create JWT auth (requires: pip install 'speechmatics-rt[jwt]')
auth = JWTAuth("your-api-key", ttl=60)

async with AsyncClient(auth=auth) as client:
    pass

Ideal for browser applications or when minimizing API key exposure. See the authentication documentation for more details.

Logging

The client supports logging with job id tracing for debugging. To increase logging verbosity, set DEBUG level in your example code:

import logging
import sys

logging.basicConfig(
    level=logging.DEBUG,
    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
    handlers=[
        logging.StreamHandler(sys.stdout)
    ]
)

Environment Variables

The client supports the following environment variables:

  • SPEECHMATICS_API_KEY: Your Speechmatics API key
  • SPEECHMATICS_RT_URL: Custom API endpoint URL (optional)

Metadata

Release files for speechmatics-rt 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for speechmatics-rt 1.2.0
File Size Uploaded
speechmatics_rt-1.2.0.tar.gz 29.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for speechmatics-rt 1.2.0
File Interpreter ABI Platform
speechmatics_rt-1.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 65.9 kB

Release files / speechmatics_rt-1.2.0.tar.gz

Download URL speechmatics_rt-1.2.0.tar.gz
Size 29.8 kB
Tags Source
SHA-256 checksum
How to use checksums
51b8f2724ad07173d32441670a08668861999fd742c84cc63c8569908f1e1621
BLAKE2b-256 checksum
How to use checksums
e91d0a78f15d6cf2ffdbc1387b4e4695f9dd46256c564fb6aaa36e85da1b1c90
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / speechmatics_rt-1.2.0-py3-none-any.whl

Download URL speechmatics_rt-1.2.0-py3-none-any.whl
Size 36.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
29e45c3692653df5a57a9f6c7a6ac590ad428022f80851b852d70cf5c4e023b0
BLAKE2b-256 checksum
How to use checksums
deae1ae9a68241ec9de2685f8d91255d1690861f2d3171466b77fd5063cde139
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page