AQaquavoice
transcription

Start an asynchronous transcription

Returns after the audio is validated and the job is stored. Poll the returned job ID or fetch its result when result_url is present.

post/audio/transcription-jobs

Request

  • Base URL
    https://api.aquavoice.com/v1
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

Optional idempotency value. Use the same value of 1–255 printable ASCII characters for retries of one logical request. Terminal results replay for 24 hours, or 10 minutes for a dictation on a zero-data-retention account; different request content returns 409 idempotency_conflict.

X-Client-Request-Idstring

Optional printable ASCII correlation value of up to 512 characters. It does not provide idempotency.

Request body multipart/form-data

filestring binary required

Audio in flac, mp3, mp4, mpeg, mpga, m4a, ogg, opus, wav, or webm format. Maximum 256 MiB and four hours of decoded audio.

model'avalon-v1.5' required

The Avalon model to use.

languagestring

ISO 639-1 language code. Omit it or use auto to detect the language.

promptstring

Context or vocabulary hints for the transcription.

response_format'json' | 'text' | 'srt' | 'vtt' | 'verbose_json' | 'diarized_json'

Response format. Defaults to json, or to diarized_json when diarize is true. A diarized transcription supports only diarized_json, srt, and vtt.

diarizeboolean

Labels who speaks each word. The result has speaker turns with word timings. Speaker IDs (spk_0, spk_1, ...) are in order of first speech. A transcription has a maximum of 8 speakers.

max_speakersinteger

The maximum number of speaker labels. Only with diarize. The speakers with the most detected speech keep their labels; words of other speakers go to the closest kept speaker. It does not change how many speakers the model detects.

temperature0

Compatibility no-op. Nonzero values are unsupported.

streamfalse

Avalon is batch-only, so only false is accepted.

timestamp_granularitiesstring[]

Only segment is supported, and only with verbose_json.

Example request

{
  "language": "auto"
}

Response

Accepted transcription job.

idstring required
object'transcription.job' required
status'queued' | 'succeeded' | 'failed' | 'cancelled' | 'abandoned' required
created_atstring date-time required
completed_atstring date-time nullable required
audio_duration_secondsnumber nullable required
error_codestring nullable required
result_urlstring nullable required

Example response

{
  "id": "req_01k2j4wr1ns8h4f7s2ckm6h1p9",
  "audio_duration_seconds": 17.8
}

Changes

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