Microphone Control | Machani Robotics SDK

curl -X POST https://api.machanirobotics.com/v1/conversation/audio/microphone:microphoneControl \
     -H "Content-Type: application/json" \
     -d '{
  "toggle": true,
  "audio": {
    "service": 2,
    "languageTag": {
      "countryTag": 840,
      "languageTag": 1033
    }
  }
}'

{
  "audioState": 1,
  "audio": {
    "service": 2,
    "languageTag": {
      "countryTag": 840,
      "languageTag": 1033,
      "inputAudio": "microphone_input_stream",
      "inputText": "Activate microphone",
      "inputSpeech": "Please turn on the microphone",
      "inputNone": false,
      "outputAudio": "response_audio_stream",
      "outputText": "Microphone activated",
      "outputSpeech": "The microphone is now on",
      "outputNone": false
    },
    "name": "session_audio_202406",
    "audioData": "UklGRiQAAABXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YQAAAAA=",
    "uploadPath": "s3://machani-audio-uploads/session_audio_202406.wav",
    "livePipelineFilePath": "/tmp/transcribe.wav",
    "vadThreshold": 0.5,
    "sampleRate": 16000,
    "wordwiseTimestamps": [
      {
        "word": "Activate",
        "start": "0.00s",
        "end": "0.45s",
        "probability": 0.98
      },
      {
        "word": "microphone",
        "start": "0.46s",
        "end": "1.10s",
        "probability": 0.95
      }
    ]
  }
}

MicrophoneControl controls the state of the microphone based on the incoming request.

When a MicrophoneControl is received, the service will either activate or deactivate the microphone. The response (MicrophoneControlRequest) includes the updated microphone state, any relevant audio data, and transcribed text if available.

HTTP Mapping: POST “/v1/conversation/audio/microphone:microphoneControl” The entire request body is forwarded to the service.

Request

This endpoint expects an object.

togglebooleanRequired

Desired state for the microphone. Set to true to activate the microphone; false to deactivate.

audioobjectRequired

Audio data and metadata associated with the control request. Provides additional context if needed during processing.

Response

audioStateintegerOptionalRead-only

The current state of the microphone after processing the control request. Indicates whether the microphone is active (on) or inactive (off).

audioobjectOptional

Audio data and associated metadata returned in the response.

Errors

400

Bad Request Error