BREAGEN Logo

Speech to Text

Overview

This API provides speech-to-text transcription services, allowing you to convert audio files into text format.

Endpoints

Audio Transcription

Convert audio files to text using speech recognition.

Endpoint: /v1/api/transcribe/
Method: POST
Content-Type: multipart/form-data

API Details

Resource URL/v1/api/transcribe/
Response FormatJSON
Requires AuthenticationNo
Rate LimitedYes
HTTPSYes

Request Parameters

ParameterDescriptionRequiredType
filesArray of audio files to transcribeYesbinary

Example Request

curl -X 'POST' \
  'https://your-api-domain.com/v1/api/transcribe/' \
  -H 'accept: application/json' \
  -H 'Content-Type: multipart/form-data' \
  -F '[email protected]'

Successful Response

{
	"is_error": false,
	"message": "Audio transcription completed successfully",
	"results": {
		"transcription": "This is the transcribed text from the audio file.",
		"confidence": 0.95,
		"duration": "00:01:23",
		"language": "en-US"
	}
}

Error Response

{
	"is_error": true,
	"message": "Validation error occurred",
	"detail": [
		{
			"loc": ["body", "files"],
			"msg": "Field required",
			"type": "value_error.missing"
		}
	]
}

Root Endpoint

Basic endpoint to check API availability.

Endpoint: /
Method: GET

API Details

Resource URL/
Response FormatHTML
Requires AuthenticationNo
Rate LimitedNo
HTTPSYes

Example Request

curl -X 'GET' 'https://your-api-domain.com/'

Successful Response

Returns an HTML page indicating the API is operational.

Error Codes

Error CodeDescription
422Validation Error - Invalid request parameters
400Bad Request - Malformed request syntax
500Internal Server Error - Server-side processing error

Notes

  • Supported audio file formats should be specified by the implementation
  • Maximum file size limits should be specified by the implementation
  • Rate limiting details should be specified by the implementation

On this page