API Error Listing for Requests

This page provides a comprehensive overview of the exception messages that may be returned by the service. These exception messages are categorized based on the type of request or operation, offering detailed insights into potential issues encountered during service usage, such as Unscripted Requests, Scripted Requests, and specific Authentication or Audio Processing errors.

Each error is listed with:

• Name: The name of the exception.
• Message: The detailed error message returned by the system.
• Parameters: Any additional information or context required for the error.
• Description: A brief explanation of when and why the error occurs.

Use this listing as a reference to understand, debug, and handle potential issues when interacting with the API effectively.

Unscripted Requests​

Unscripted requests involve real-time or asynchronous operations where the API processes input dynamically without relying on predefined scripts or workflows. These requests are often used for scenarios such as live audio processing, ad-hoc ASR (Automatic Speech Recognition) tasks, or other dynamic interactions.

ASR Exceptions​

Exception

Message

Parameters

Description

ASRInterProcessException

exception in ASR: {error}

error (str): Details of the error.

Raised when there is an inter-process exception in the ASR system.

ASRSocketTimeout

ASR timeout

None

Raised when the ASR system times out while processing.

ASRConnectionFailed

ASR Connection Failed

None

Raised when the connection to the ASR system fails.

Audio Exceptions​

Exception

Message

Parameters

Description

FailedToReadAudioFromURL

Failed to read audio from the URL

None

Raised when the server cannot read the audio from the provided URL.

FailedToParseAudioHeader

Failed to parse audio header

None

Raised when the audio header cannot be parsed.

InvalidAudioFormat

Only 16 kHz mono WAV, FLAC or OGG-Opus audio allowed

None

Raised when the provided audio format is invalid.

FailedToConvertAudio

The server failed to parse your {audio_format} audio

audio_format (str): The format of the audio that failed conversion.

Raised when the server fails to convert the provided audio format.

FailedToDecodeAudioFromBytes

Failed to decode audio

None

Raised when the server fails to decode audio data from bytes.

MissingAudioParam

Missing audio param!

None

Raised when the required audio parameter is missing.

AudioTooBigForSync

Audio is too big for sync mode, please change to async mode

stream_dir (str): Directory or location of the audio stream.

Raised when the provided audio is too large for synchronous processing.

FailedToUseAudio

An unexpected error occurred while processing the audio. Please check if the audio is valid and it's not corrupted.

None

Raised when an unexpected error occurs while processing the audio.

Authentication Exceptions​

Exception

Message

Parameters

Description

NoTokenProvided

No session token provided

None

Raised when no session token is provided.

InvalidSessionToken

Invalid session token: {token}

token (str): The invalid session token.

Raised when an invalid session token is provided.

UserDoesNotExist

Could not find {user_type} ID

user_type (str): The type of user ID.

Raised when the specified user does not exist.

ClientIsNotActive

Client with {user_id} is not active

user_id (str): The user ID.

Raised when the specified client is not active.

ClientDoesNotHaveAccess

User {user_id} does not have access for this API

user_id (str): The user ID.

Raised when the specified client does not have access to the API.

ClientHasNoMoreMinutes

User has no remaining minutes

None

Raised when the user has no remaining minutes for API usage.

Scripted Requests​

Scripted requests involve predefined workflows or operations that follow a specific sequence or script. These requests are commonly used in scenarios where the input and expected output are well-defined, such as processing audio based on a predetermined script, executing automated tasks, or handling structured workflows.

Audio Exceptions​

Exception

Message

Parameters

Description

MissingAudioParam

Missing audio param!

None

Raised when the required audio parameter is missing.

FailedToReadAudioFromURL

Failed to read audio from the URL

None

Raised when the server cannot read the audio from the provided URL.

FailedToConvertAudio

The server failed to parse your {audio_format} audio

audio_format (str): The format of the audio that failed conversion.

Raised when the server fails to convert the provided audio format.

FailedToUseAudio

An unexpected error occurred while processing the audio. Please check if the audio is valid and it's not corrupted.

None

Raised when an unexpected error occurs while processing the audio.

Authentication Exceptions​

Exception

Message

Parameters

Description

NoTokenProvided

No session token provided

None

Raised when no session token is provided.

ClientIsNotActive

Client with {user_id} is not active

user_id (str): The user ID.

Raised when the specified client is not active.

ClientDoesNotHaveAccess

User {user_id} does not have access for this API

user_id (str): The user ID.

Raised when the specified client does not have access to the API.

UserDoesNotExist

Could not find {user_type} ID

user_type (str): The type of user ID.

Raised when the specified user does not exist.

InvalidHeaderParameter

A valid authorization header is required

None

Raised when the authorization header is invalid or missing.