Archived Version: v2025.08
You are viewing an archived reference version.
Overview of the WebSocket stream used for live event delivery.
The Live Events API provides real-time access to audio events detected by the Deeply system. This API uses a WebSocket connection to stream event data continuously, allowing clients to monitor events as they happen in real-time.
ws://localhost:8100/api/v1/wsThis page uses the local default host shown throughout the reference.
Clients can connect to this WebSocket endpoint to receive live events in real time. Each event received through this endpoint follows the Event object structure, providing comprehensive information about the detected audio event.
Each WebSocket message contains a JSON object with the following structure:
stringobjectstring): Unique identifier of the sound labelobject): Localized names of the label
string): Korean namestring): English namefloatobjectstring): Unique identifier of the microphonestring): Name of the microphoneobject): Geographic location of the device
number): Latitude coordinatenumber): Longitude coordinateArray[float]In this example, the noises array contains 20 measurements over a 2-second period,
with values ranging from approximately 58 dB to 71 dB, indicating moderate sound levels typical of normal speech.
{
"id": "23d6ec74155f4eb187b4e7301b71b5d9",
"label": {
"id": "normal_speech_female",
"name": {
"ko": "대화(여성)",
"en": "normal speech female"
}
},
"confidence": 0.426632,
"mic": {
"id": "d00c8e3364a34439183e3462e773354a1",
"name": "Example Mic (715)",
"location": {
"latitude": 37.546344,
"longitude": 126.944322
}
},
"noises": [
66.99,
65.28,
68.21,
68.12,
67.56,
70.66,
67.35,
63.42,
59.98,
64.05,
65.86,
62.88,
62.41,
62.59,
61.96,
59.25,
58.16,
59.75,
64.2,
65.15
]
}