Errors Making Requests to the API
The API always returns a JSON response when there's an error.
Invalid API Token
API requests made with an invalid API key always return a
401 status code and a JSON response like:
"error": "Authentication error, API token missing/invalid"
Invalid API Request
When something is wrong with your API request, the API returns with a status code
"error": "format_text must be a Boolean"
error key always contains more information about what was wrong with your request.
When something is wrong on our side, the API returns with a status code
"error": "Server error, developers have been alerted."
Failed Transcription Jobs
A transcription job can fail because something was wrong with your audio file, or because of an error on our side.
Whenever a transcription job fails, the status of the transcription changes to
error, and there's an
error key in the JSON response from the API when fetching the transcription with a GET request.
error key describes the error in more detail. For example:
// the status is shown as error here
// the error is described in detail here
"error": "Download error to https://foo.bar, 403 Client Error: Forbidden for url: https://foo.bar",
Transcripts can fail if a file is extremely short (less than 200ms), doesn't contain any actual audio, or if your file can't be retrieved by our API. You can test if an audio or video file can be downloaded directly by pasting the URL for your file directly into your browser's URL bar. If the file downloads rather than displaying a webpage, it should work. Only the currently supports retrieving videos directly from YouTube links.
When a transcription job fails due to an error on our side (a server error), we recommend resubmitting the file for transcription. If you encounter any issues or have any questions, you can refer to our FAQ or reach out to our Support team.