Audio Event Detection
Audio Event Detection Batch
Detect non-speech sound events in an audio file. Returns a probability for each event confidently detected, plus the audio duration, in a single synchronous response.
POST
/
api
/
velma-2-audio-event-classifier
Detect audio events in an audio file
curl --request POST \
--url https://platform.modulate.ai/api/velma-2-audio-event-classifier \
--header 'Content-Type: multipart/form-data' \
--header 'X-API-Key: <api-key>' \
--form upload_file=@example-fileimport requests
url = "https://platform.modulate.ai/api/velma-2-audio-event-classifier"
files = { "upload_file": ("example-file", open("example-file", "rb")) }
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('upload_file', '<string>');
const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
options.body = form;
fetch('https://platform.modulate.ai/api/velma-2-audio-event-classifier', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.modulate.ai/api/velma-2-audio-event-classifier",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.modulate.ai/api/velma-2-audio-event-classifier"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.modulate.ai/api/velma-2-audio-event-classifier")
.header("X-API-Key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.modulate.ai/api/velma-2-audio-event-classifier")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"probs": {
"Applause": 0.998,
"Laughter": 0.946
},
"duration_ms": 2000
}Authorizations
API key used for authentication and usage tracking.
Body
multipart/form-data
Audio file to analyze. Must be non-empty and of a supported format. Supported formats: AAC, AIFF, FLAC, MP3, MP4, MOV, OGG, Opus, WAV, WebM. Maximum file size: 100 MB.
Response
Event detection completed successfully.
Per-event probabilities, each between 0 and 1. Only events
confidently detected in the audio are included - an omitted
event was not detected with sufficient confidence, which does
not necessarily mean it is absent from the audio. Included
events are not mutually exclusive, and the set of included
probabilities is not expected to sum to 1. probs is an empty
object when no event was confidently detected.
Show child attributes
Show child attributes
The total duration of the processed audio in milliseconds.
Required range:
x >= 0Example:
14253
Detect audio events in an audio file
curl --request POST \
--url https://platform.modulate.ai/api/velma-2-audio-event-classifier \
--header 'Content-Type: multipart/form-data' \
--header 'X-API-Key: <api-key>' \
--form upload_file=@example-fileimport requests
url = "https://platform.modulate.ai/api/velma-2-audio-event-classifier"
files = { "upload_file": ("example-file", open("example-file", "rb")) }
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('upload_file', '<string>');
const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
options.body = form;
fetch('https://platform.modulate.ai/api/velma-2-audio-event-classifier', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.modulate.ai/api/velma-2-audio-event-classifier",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.modulate.ai/api/velma-2-audio-event-classifier"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.modulate.ai/api/velma-2-audio-event-classifier")
.header("X-API-Key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.modulate.ai/api/velma-2-audio-event-classifier")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"probs": {
"Applause": 0.998,
"Laughter": 0.946
},
"duration_ms": 2000
}