Skip to navigation
API ReferenceRecordings

Upload a recording for analysis

Uploads a Base64-encoded audio file. Analysis processing is triggered on a successful upload and may take up to five minutes to complete.

Minimum audio requirements:

  • Format: WAV, MP3, MP4, or OGG
  • Sample rate: 8,000 Hz
  • Bit rate: 32,000 bps
  • Channels: 1 (mono)
  • Duration: 30 seconds of speech
  • Maximum file size: 50 MB

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
account_idstringRequiredformat: "uuid"
The ID of the account submitting the recording.
recorded_atdatetimeRequired
ISO 8601 timestamp of when the recording began.
analysislist of enumsRequired
Analysis types to run. Must contain at least one type.
Allowed values:
audiostringRequired

Base64-encoded audio file.

Response

Recording uploaded
recording_idstringOptionalformat: "uuid"
The recording ID used for fetching analysis results.
account_idstringOptionalformat: "uuid"
The ID of the account that submitted the recording.
recorded_atdatetimeOptional
ISO 8601 timestamp of when the recording began.
uploaded_atdatetimeOptional
ISO 8601 timestamp of when the recording was uploaded.
audio_file_formatstringOptional
Detected audio file format.
audio_size_bytesintegerOptional
Audio file size in bytes.
audio_sample_rate_hzintegerOptional
Audio sample rate in Hz.
audio_bit_rate_bpsintegerOptional
Audio bit rate in bits per second.
audio_duration_secondsdoubleOptional
Total audio duration in seconds.
speech_duration_secondsdoubleOptional
Detected speech duration in seconds.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
413
Content Too Large Error
500
Internal Server Error