Create transcription
POST/audio/transcriptions
Transcribes one audio file, in the format of OpenAI's speech-to-text API (client.audio.transcriptions.create in the OpenAI SDKs), with vibevoice-asr (alias microsoft/vibevoice-asr). The request is a multipart/form-data form with the file and the model. With verbose_json, the answer adds the duration and the segments, each with its start, end and speaker. More than 50 languages are detected automatically. At most 5 minutes of audio and a body of 16 MiB per request. Audio, transcripts and prompts are processed in memory only: they are never written to disk or logs and never used for training.
Billed per second of audio, rounded up, at least one second, at the price in audio_pricing.per_second of GET /v1/models?format=openai; usage.seconds of the answer is what was billed. A request that ends in an error is not billed. The model marks audio without speech with tags such as [Silence]; send remove_nonspeech_tags=true to remove them. A transcription that takes more than about 20 seconds is answered 200 at once with blank lines until the transcript follows; JSON parsers skip them. Only Serenity Edge API keys can use this route. See the Speech to text guide.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 413
- 429
- 500
- 503
The transcript. json, the default, gives text and usage; verbose_json adds the language sent, the duration and the segments; text gives the transcript alone as text/plain.
The request was refused: a body that is not a multipart/form-data form, no file or model, a second file, an audio format that is not supported, audio longer than 5 minutes (when the file states its duration), srt or vtt, word timestamps, a remove_nonspeech_tags other than true or false, a field out of range, or a model served on another route. param names the field at fault when there is one.
Missing or invalid API key.
The key is valid but cannot use this route: only Serenity Edge API keys can. Any other key, such as a key from a Serenity Star account, gets permission_denied.
The model id is unknown, or it is a model of another route (model_not_found).
The request body, or the audio file in it, is larger than this route accepts (16 MiB, request_too_large).
Rate limit exceeded, or the service is temporarily at capacity for this model. Wait for the number of seconds in the Retry-After header before retrying.
Response Headers
Seconds to wait before retrying.
The file took too long to transcribe (timeout): split it into shorter requests. Or an unexpected server error: the model service returned an unexpected response (upstream_error), or an error in the gateway. A transcription that fails after the 200 has started comes as this error object in the body instead; with text, the connection is closed before the end.
The model service is temporarily unavailable (upstream_unavailable). Retry later and check the status page at https://status.serenityedge.ai.