GET
/v1/schemas/dashscope/audio/audio/transcriptions
Accept:
| field | recorded source |
|---|---|
| schema | Source linked above. generated Source trace3f115c72cf761f250dffef5a1bd0e50d58f35e9e0b9415901622880fdbca3418{
"fetchedAt": 1793250643,
"extractorVersion": "1",
"verifiedAt": null
} |
Request body
14 properties · 2 required · 4 $defs| property | type | description | constraints |
|---|---|---|---|
| file* | string | The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata for the file to be identified. We recommend an extension-bearing filename and an a… | format: binary |
| model* | string | enum | ID of the model to use. The options are `gpt-transcribe`, `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `whisper-1` (which is powered by our open source Whisper V2 model), and `gpt-4o-transcribe-diarize`. | |
| language | string | The language of the input audio. Supplying the input language in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format will improve accuracy and latency. | |
| languages | string[] | Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Supported by `gpt-transcribe`. | items ≥ 1 |
| keywords | string[] | Words or phrases to guide transcription of the input audio. Supported by `gpt-transcribe`. | |
| prompt | string | An optional text to guide the model's style or continue a previous audio segment. The [prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting) should match the audio language. This field is not supported when using `gpt-4o-transcribe-di… | |
| response_format | enum | The format of the output, in one of these options: `json`, `text`, `srt`, `verbose_json`, `vtt`, or `diarized_json`. For `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`, the only supported format is `json`. For `gpt-4o-transcribe-diarize`, the supported forma… | json | text | srt | verbose_json | vtt | diarized_json · default: "json" |
| temperature | number | 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. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_pro… | default: 0 |
| include | TranscriptionInclude[] | Additional information to include in the transcription response. `logprobs` will return the log probabilities of the tokens in the response to understand the model's confidence in the transcription. `logprobs` only works with response_format set to `json` and … | |
| timestamp_granularities | enum[] | The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment t… | default: ["segment"] |
| stream | boolean | If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). See the [Streaming section o… | default: false · nullable |
| chunking_strategy | enum | object | Controls how the audio is cut into chunks. When set to `"auto"`, the server first normalizes loudness and then uses voice activity detection (VAD) to choose boundaries. `server_vad` object can be provided to tweak VAD detection parameters manually. If unset, t… | nullable |
| known_speaker_names | string[] | Optional list of speaker names that correspond to the audio samples provided in `known_speaker_references[]`. Each entry should be a short identifier (for example `customer` or `agent`). Up to 4 speakers are supported. | items ≤ 4 |
| known_speaker_references | string[] | Optional list of audio samples (as [data URLs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs)) that contain known speaker references matching `known_speaker_names[]`. Each sample must be between 2 and 10 seconds, and can use any of… | items ≤ 4 |
Types
4 $defsAudioResponseFormatenum
The format of the output, in one of these options: `json`, `text`, `srt`, `verbose_json`, `vtt`, or `diarized_json`. For `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`, the only supported format is `json`. For `gpt-4o-transcribe-diarize`, the supported forma…
json | text | srt | verbose_json | vtt | diarized_json · default: "json"
TranscriptionChunkingStrategyenum | object
Controls how the audio is cut into chunks. When set to `"auto"`, the server first normalizes loudness and then uses voice activity detection (VAD) to choose boundaries. `server_vad` object can be provided to tweak VAD detection parameters manually. If unset, t…
nullable
TranscriptionIncludeenum
logprobs
VadConfigobject
| type* | enum | Must be set to `server_vad` to enable manual chunking using server side VAD. | server_vad |
| prefix_padding_ms | integer | Amount of audio to include before the VAD detected speech (in milliseconds). | default: 300 |
| silence_duration_ms | integer | Duration of silence to detect speech stop (in milliseconds). With shorter values the model will respond more quickly, but may jump in on short pauses from the user. | default: 200 |
| threshold | number | Sensitivity threshold (0.0 to 1.0) for voice activity detection. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments. | default: 0.5 |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"dashscope","endpointId":"audio/transcriptions","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}