Deeply API Documentation main logoDeeply API Documentation main logo textDeeply API Documentation main logo text
User GuideServer API Reference
Search...
k
LanguageENKO

© 2026 Deeply Inc.

Deeply Logo Icon

Deeply API Documentation

    Release Notes

    Quick Start

    API Quick Start Guide
    Authorization
    Rate Limit

    Architecture

    Overall Architecture
    Edge Server System

    Events

    Events
    Event Categories
    List Events
    GET
    Get An Event
    GET

    Composite Events

    Composite Events
    List Composite Events
    GET
    Get A Composite Event
    GET
    Listen Live Composite Events
    WebSocket

    Live Events

    Live Events
    Listen Live Events
    WebSocket

    Edges

    Edge Server
    List Edge Servers
    GET
    Get An Edge Server
    GET
    Update Edge Server
    PATCH

    Microphones

    Mic Device
    List Mic Devices
    GET
    Get A Mic Device
    GET
    Update Mic Device
    PATCH

    Auth

    Reissue Token
    GET
    1. Reference
    2. Events
    3. Event Categories

    Event Categories

    This section provides an overview of the event categories provided by Deeply.

    Last updated: November 11, 2026

    Event Categories

    Deeply AI system can detect various types of sound events. Each event type has its own characteristics and use cases.

    Sound Level Detection

    sound_level

    • Description: General sound level detection without specific classification
    • Use Case: Monitoring overall noise levels in an environment

    Voice Events

    breathing_heavily

    • Description: Detection of heavy or labored breathing sounds
    • Use Case: Health monitoring, emergency detection

    crying

    • Description: Detection of crying sounds
    • Use Case: Emergency situations, emotional distress monitoring

    scream_female

    • Description: Detection of female screaming sounds
    • Use Case: Emergency detection, security monitoring

    scream_male

    • Description: Detection of male screaming sounds
    • Use Case: Emergency detection, security monitoring

    aggressive_yell_female

    • Description: Detection of aggressive yelling by female voices
    • Use Case: Conflict detection, security monitoring

    aggressive_yell_male

    • Description: Detection of aggressive yelling by male voices
    • Use Case: Conflict detection, security monitoring

    normal_speech_female

    • Description: Detection of normal female speech
    • Use Case: General activity monitoring

    normal_speech_male

    • Description: Detection of normal male speech
    • Use Case: General activity monitoring

    Emergency Keywords

    save_me

    • Description: Detection of "save me" calls for help
    • Use Case: Emergency situation detection

    help_me

    • Description: Detection of "help me" calls for help
    • Use Case: Emergency situation detection

    Environmental Sounds

    physical_impacts

    • Description: Detection of impact sounds (e.g., falling, collision)
    • Use Case: Accident detection, security monitoring

    glass_break

    • Description: Detection of glass breaking sounds
    • Use Case: Break-in detection, security monitoring

    Usage Notes

    • Each event category can be configured with different threshold values
    • Thresholds determine the sensitivity of detection for each event type
    • Values range from 0 to 1, where:
      • 0: Maximum sensitivity (detects even slight sounds)
      • 1: Minimum sensitivity (only detects very clear sounds)

    Each threshold values are controlled by microphone. Refer to Microphone for more details.

    Events
    List Events
    Event CategoriesSound Level Detectionsound_levelVoice Eventsbreathing_heavilycryingscream_femalescream_maleaggressive_yell_femaleaggressive_yell_malenormal_speech_femalenormal_speech_maleEmergency Keywordssave_mehelp_meEnvironmental Soundsphysical_impactsglass_breakUsage Notes