Skip to main content
POST
/
api
/
v2
/
AQL
/
SpeechToText
Convert Speech to Text
curl --request POST \
  --url https://gateway.widebot.net/api/v2/AQL/SpeechToText \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-bot: <api-key>' \
  --header 'x-user-auth: <api-key>' \
  --form SessionId=test-session-123 \
  --form SetDefaultSampleRate=true \
  --form TargetLanguage=ar-eg \
  --form MaxRecordLengthInSeconds=180 \
  --form Record='@example-file'
{
  "StatusCode": 200,
  "Response": "مرحباً، كيف حالك اليوم؟ أتمنى أن تكون بخير.",
  "Consumption": "15/1000"
}

Authorizations

​
x-user-auth
string
header
required

Your API key from account settings

​
x-bot
string
header
required

Your bot ID from account settings

Body

multipart/form-data
​
Record
file

Audio file to transcribe

​
SessionId
string

Unique session identifier for tracking

Example:

"test-session-1234"

​
SetDefaultSampleRate
enum<string>

Whether to use default sample rate optimization

Available options:
true,
false
Example:

"true"

​
TargetLanguage
string

Language code for transcription output

Example:

"ar-eg"

​
MaxRecordLengthInSeconds
string

Maximum audio duration to process

Example:

"180"

Response

200 - application/json

Transcription successful

​
StatusCode
integer
Example:

200

​
Response
string

Transcribed text from audio

Example:

"مرحباً، كيف حالك اليوم؟ أتمنى أن تكون بخير."

​
Consumption
string

Audio duration consumed

Example:

"15/1000"