Skip to main content
POST
Convert Speech to Text

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
required

Audio file to transcribe

SessionId
string
required

Unique session identifier for tracking

Example:

"test-session-1234"

TargetLanguage
enum<string>
required

Language of the resulting text (en or ar)

Available options:
en,
ar
Example:

"ar"

ModelName
enum<string>
required

Required. Speech-to-text model.

  • v1: Best Arabic quality, with strong streaming. Choose this for Arabic-only audio.
  • v2: Handles Arabic and English. Choose this when the audio mixes or switches between the two languages.
Available options:
v1,
v2
Example:

"v1"

SetDefaultSampleRate
enum<string>

Set to "true" to use the default sample rate. Provide this or an explicit SampleRate; transcription fails without sample-rate information.

Available options:
true,
false
Example:

"true"

MaxRecordLengthInSeconds
string

Maximum audio duration to process

Example:

"180"

RecordUrl
string<uri>

Optional. URL of an audio file to transcribe.

Example:

"https://cdn.widebot.net/tmp/audio/sample.wav"

SampleRate
string

Sample rate of the provided audio in Hz

Example:

"16000"

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"