FRfriendli
Dedicated.Audio

Audio transcriptions

Given an audio file, the model transcribes it into text.

post/dedicated/v1/audio/transcriptions

Request

Headers

X-Friendli-Teamstring nullable

ID of team to run requests as (optional parameter).

Request body multipart/form-data

modelstring required

ID of target endpoint. If you want to send request to specific adapter, use the format "YOUR_ENDPOINT_ID:YOUR_ADAPTER_ROUTE". Otherwise, you can just use "YOUR_ENDPOINT_ID" alone.

filestring binary required

The audio file object (not file name) to transcribe, in one of these formats: mp3, wav, flac, ogg, and many other standard audio formats.

languagestring nullable

The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.

streamboolean nullable

Whether to stream the transcription result. When set to true, the transcription result will be streamed as server-sent events once generated.

temperaturenumber nullable

The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

Example request

{
  "file": "@/path/to/file/audio.mp3",
  "model": "(endpoint-id)"
}

Response

Successfully transcribed the audio file.

textstring required

The transcribed text.

Changes

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