Audio

Record an audio clip

Captures audio via the AudioPiper companion app. mode=clip records N seconds starting now and returns base64 WAV (or writes to save_path if provided). mode=status returns the current AudioPiper mixer state. Optionally pipes the clip through speech-to-text via return_transcript: true. Inline payloads capped at 25 MB; max duration 600 s (10 min).

post/v1/audio/record

Request

  • Base URL: http://localhost:9998
  • URL: http://localhost:9998/v1/audio/record
  • Auth: HTTP bearer

Request body

mode'clip' | 'status'

Capture mode. Default clip.

duration_secondsnumber

Clip length in seconds. Default 30. Max 600 (10 min). mode=clip only.

save_pathstring

Absolute path to write WAV. If omitted, returns base64 (capped at 25 MB). mode=clip only.

return_transcriptboolean

Also run transcribe on the captured audio and return text. mode=clip only. Default false.

Response

Captured clip or AudioPiper status

mode'clip' | 'status' required
duration_secondsnumber
bytesinteger
audio_base64string

Base64-encoded WAV (omitted when path is set or mode=status)

pathstring

Absolute path written to disk (omitted when audio_base64 is set or mode=status)

transcriptstring

Speech-to-text result (only when return_transcript: true and STT succeeded)

transcript_errorstring

STT error message (only when return_transcript: true and STT failed)

statusobject

AudioPiper mixer state (only when mode=status)

Changes

No recorded changes to this operation across all 1 revision of this API.