Transcribe an audio or video file.
POST/api/v2/Audio/transcribe
Transcribes an audio or video file into text. Supported file formats: mp3, mp4, mpeg, mpga, m4a, wav, webm. Maximum file size: 25 MB.
Request
Query Parameters
Use this param to override the culture of the response. Options: - en (default) - es
- multipart/form-data
Body
The AI Model Id to use for transcription. If not provided, the default audio model will be used.
The audio or video file to transcribe.
Optional prompt to guide the transcription. Useful for providing context or specifying terminology.
Possible values: <= 256 characters
Optional user identifier for tracking and cost management purposes.
Possible values: <= 100 characters
The channel used in the execution
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Returns the transcription result.
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
metadata
object
tokenUsage
object
cost
object
{
"instanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transcript": "string",
"metadata": {
"language": "string",
"duration": "string"
},
"tokenUsage": {
"completionTokens": 0,
"promptTokens": 0,
"totalTokens": 0
},
"cost": {
"completion": 0,
"prompt": 0,
"total": 0,
"currency": "string"
}
}
- Schema
- Example (from schema)
Schema
metadata
object
tokenUsage
object
cost
object
{
"instanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transcript": "string",
"metadata": {
"language": "string",
"duration": "string"
},
"tokenUsage": {
"completionTokens": 0,
"promptTokens": 0,
"totalTokens": 0
},
"cost": {
"completion": 0,
"prompt": 0,
"total": 0,
"currency": "string"
}
}
- Schema
- Example (from schema)
Schema
metadata
object
tokenUsage
object
cost
object
{
"instanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transcript": "string",
"metadata": {
"language": "string",
"duration": "string"
},
"tokenUsage": {
"completionTokens": 0,
"promptTokens": 0,
"totalTokens": 0
},
"cost": {
"completion": 0,
"prompt": 0,
"total": 0,
"currency": "string"
}
}
If the request validation fails (invalid file format, size, etc.) or insufficient balance.
The user is unauthorized or the session expired
The user does not have permission
If the specified model is not found.
There was an unexpected error