Realtime API
Overview
Learn about Fireflies.ai’s Realtime API for live transcription
The Fireflies.ai Realtime API allows your application to receive live transcription events over WebSockets. This enables building interactive features such as live captioning, transcription overlays, and real-time analysis as users speak.
The Realtime API is currently in beta. Features and endpoints may change. We welcome your feedback as we continue to improve this API.
How It Works
The Realtime API uses WebSocket connections to deliver transcription data as it’s generated.
Flow
- Authenticate: Connect using a valid API token and transcript ID.
- Listen: Once connected, you’ll start receiving transcription events in real time.
- React: Update your UI or process transcription events as they arrive.
Features
- Low Latency: Data is streamed as soon as it’s transcribed.
- Event-Based: Receive structured events for easy handling.
- Token-Based Authentication: Secure connections with scoped access.
- Incremental Transcription: Receive transcript segments progressively.