diarize | boolean | :heavy_minus_sign: | Label each word with the speaker who said it (words[].speaker, words[].speaker_label). Requires response_format “verbose_json” (400 otherwise); word timestamps are included even when timestamp_granularities[] omits “word”. Only supported by some providers; 400 when the selected model cannot diarize. |
file | File | Blob | operations.CreateAudioTranscriptionsMultipartFile | :heavy_minus_sign: | The audio file to transcribe. The format is derived from the filename extension or the file part content type. Max 25 MB; send larger files as base64 JSON via input_audio, or by URL via source_url. Exactly one of file or source_url is required. |
keyterms | string[] | :heavy_minus_sign: | Domain terms, names, or phrases to bias recognition toward; repeat the part once per term (keyterms=… is also accepted). Only supported by some providers; 400 when the selected model cannot use keyterms. |
language | string | :heavy_minus_sign: | The language of the input audio (ISO-639-1). |
model | string | :heavy_check_mark: | The model to use for transcription. |
provider | string | :heavy_minus_sign: | JSON-encoded provider preferences object, the same shape as the JSON body field: { “options”: { “<provider-slug>”: { … } } }. Only options for the matched provider are forwarded. Must decode to a JSON object. |
responseFormat | operations.ResponseFormat | :heavy_minus_sign: | The response format. “json” (default) returns { text, usage }; “verbose_json” additionally returns task, language, duration, and segment-level timestamps (OpenAI-compatible providers only). |
sessionId | string | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. |
sourceUrl | string | :heavy_minus_sign: | Publicly reachable http(s) URL of the audio file, downloaded by the provider directly (no size limit on our side). The format is derived from the URL path extension. Only supported by some providers; exactly one of file or source_url is required. |
temperature | number | :heavy_minus_sign: | The sampling temperature. |
timestampGranularities | operations.TimestampGranularities[] | :heavy_minus_sign: | Timestamp detail levels to include when response_format is “verbose_json”. “word” additionally returns word-level timestamps in the words array. |
trace | string | :heavy_minus_sign: | JSON-encoded trace metadata object (trace_id, trace_name, span_name, generation_name, parent_span_id and custom keys) attached to the Broadcast trace. Must decode to a JSON object. |
user | string | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. |
