Overview
This guide shows you how to connect to the Fireflies.ai Realtime API and start receiving transcription events in real time.
Endpoint
Requirements
You’ll need the following:
- A valid API token
- A
transcriptId
(or meeting ID)
Connecting via Socket.IO
Use the Socket.IO client to connect and listen for events.
import { io } from 'socket.io-client';
const socket = io('wss://api.fireflies.ai', {
path: '/ws/realtime',
auth: {
token: 'Bearer <YOUR_API_TOKEN>',
transcriptId: '<TRANSCRIPT_ID>'
}
});
socket.on('auth.success', data => {
console.log('Authenticated:', data);
});
socket.on('auth.failed', err => {
console.error('Authentication failed:', err);
});
socket.on('connection.error', err => {
console.error('Connection error:', err);
});
socket.on('connection.established', () => {
console.log('Connection established');
});
socket.on('transcription.broadcast', event => {
console.log('Transcript event:', event);
});
Auth Parameters
Field | Type | Description |
---|
token | string | Your API access token |
transcriptId | string | ID of the meeting or transcript |
If authentication fails, the server emits an auth.failed
event and disconnects the socket.
See Authorization
Additional Resources
Responses are generated using AI and may contain mistakes.