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. Requires an active subscription with available credits; requests are rejected once the balance is exhausted or the subscription is suspended.

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.

isolate_oldest_speakerbooleanOptionalDefaults to false

When true, the clip is diarised and only the audio of the speaker estimated to be oldest is kept and analysed. Speaker age is estimated from the audio and carries a multi-year error bar, so speakers close in age may not be separated reliably. The retained speaker’s speech must clear the same 30-second minimum the whole clip does, or the upload is rejected with a SpeakerSpeechTooShort error. Recordings longer than 10 minutes are rejected with a RecordingTooLongForIsolation error.

Response

Recording uploaded
recording_idstringformat: "uuid"
The recording ID used for fetching analysis results.
account_idstringformat: "uuid"
The ID of the account that submitted the recording.
recorded_atdatetime
ISO 8601 timestamp of when the recording began.
uploaded_atdatetime
ISO 8601 timestamp of when the recording was uploaded.
audio_file_formatstring
Detected audio file format.
audio_size_bytesinteger

Audio file size in bytes. With isolate_oldest_speaker enabled, this describes the retained audio, not the submitted file.

audio_sample_rate_hzinteger
Audio sample rate in Hz.
audio_bit_rate_bpsinteger
Audio bit rate in bits per second.
audio_duration_secondsdouble

Total audio duration in seconds. With isolate_oldest_speaker enabled, this is the duration of the retained speaker’s audio, not of the submitted clip.

speech_duration_secondsdouble

Detected speech duration in seconds. With isolate_oldest_speaker enabled, this is the isolated speaker’s speech time, not the whole clip’s.

Errors

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