Mic Device API Overview

Microphone Device of Deeply AI System

Device Object#

The Device object represents an individual microphone device within the Deeply system that captures audio data. Each device is associated with an edge server and includes information about its location and operational status.

Attributes#

id#

• Type: string
• Description: A unique identifier for the device.

name#

• Type: string
• Description: The name of the device, typically used for easy identification.

edge_id#

• Type: string
• Description: The unique identifier of the edge server managing this device.

location#

• Type: object
• Description: Geographic coordinates of the device's location.
  • latitude (number): Latitude coordinate (-90 to 90).
  • longitude (number): Longitude coordinate (-180 to 180).

status#

• Type: enum(active | inactive)
• Description: The operational status of the device. Possible values:
  • "active": The device is online and operational
  • "inactive": The device is offline or not in use

thresholds#

• Type: object
• Description: Detection threshold values for various sound events
  • Each key represents a specific event type (e.g., "breathing_heavily", "scream_female", etc.)
  • Each value is an object with the following properties:
    • sound_level_ge (number): The minimum sound level (in decibels, between 0 to 100) required for the event to be detected.
    • confidence (number): The minimum confidence level (between 0 and 1) required for the event to be detected.
  • For available event types and their descriptions, refer to Event Categories

created_at#

• Type: string, ISO 8601 format
• Description: The timestamp when the device was first registered in the system.

updated_at#

• Type: string, ISO 8601 format
• Description: The timestamp of the most recent update to the device's information.

---

Refer to Get A Mic Device for a detailed response example.