Common Errors

Attributes of error response

Whenever the API returns an error, the response will appear as follows:

Sample error response

{
    "status": "error",
    "short_message": "error_invalid_parameters",
    "detail_message": "key"
}

The attributes of the response are:

• status: This determines whether the response is a success or an error.

• short_message : The type of error returned. Some of the possible errors are error_audio_too_long, error_missing_parameters or error_invalid_parameters.

• detail_message : A human-readable message providing more details about the error.

Errors

Below is the list of common errors returned by the API and their solutions:

Error	Cause and Solution
error_unknown_words	Cause: One or more words are outside of Speechace lexicon. Solution: You should use the Validate Text API to validate text at the time of activity authoring to catch such errors and address them by changing the text or making requests to add terms to the Speechace lexicon. Alternatively you can pass the include_unknown_words parameter to automatically handle such words
error_audio_too_long	Cause: Your audio duration is longer than is allowed for your API license. Solution: You should limit the recording size or contact [e-mail] to upgrade your plan.
error_file_too_large	Cause: Your audio file size is larger than is allowed for your API license. Solution: You should ensure you are recording at the required sample rate and no higher to optimize file size.
error_audio_missing	Cause: The audio file was not correctly passed or is missing. Solution: Check the form data field in the request body of the cURL.
error_missing_parameters	Cause: One or more API parameters were missing. Solution: Check the detail_message in the error response for the missing parameter.
error_invalid_parameters	Cause: One or more API parameters were missing. Solution: Check the detail_message in the error response for the missing parameter.
error_convert_audio	Cause: The audio is either corrupt or not provided in a valid format such as mp3, wav, webm, aac etc. Solution: Please check that the audio file is not corrupt and is in acceptable formats.
error_too_many_requests	You are being throttled because you have exceeded the allowed concurrent request volume
error_feature_unavailable	Cause: You attempted to access a feature not provided in your subscription. Solution: Contact [e-mail] to upgrade your plan.
error_key_expired	Cause: Your API Key is not active. Solution: Please check your subscription status or contact [e-mail]
error_no_speech	Cause: No human voice detected in the provided audio file. Solution: Ensure that the audio file contains clear human speech.
error_word_alignment	Cause: The audio did not align with any of the words in the intended text, possibly due to background noise or unclear speech. Solution: Check for background noise and ensure that the speech in the audio file is clear and distinct.
error_text_too_long	Cause: The text you have submitted is longer than 1500 characters. Solution: Shorten the text to meet the character limit.
error_internal	Cause: A catch-all error for various unforseen cases. Solution: Consult [e-mail] for assistance with this general error.

Support

If you are unable to understand or address an error you can raise a support ticket.