Errors
The Icana Transcription API uses standard HTTP status codes to indicate success or failure.
HTTP Status Codes
| Status Code |
Meaning |
200 |
Success |
400 |
Bad Request — missing or invalid parameters |
401 |
Unauthorized — invalid or missing API key |
404 |
Not Found — resource does not exist |
500 |
Internal Server Error — server configuration error or unexpected failure |
Error Scenarios by Endpoint
POST /upload
| Status |
Cause |
400 |
No file part in request, or no file selected |
401 |
Invalid or missing X-API-Key header |
500 |
Server configuration error or S3 upload failure |
POST /transcribe
| Status |
Cause |
400 |
Missing s3_uri or invalid JSON body |
401 |
Invalid or missing X-API-Key header |
500 |
Server configuration error or AWS Batch job submission failure |
GET /status/{aws_batch_job_id}
| Status |
Cause |
401 |
Invalid or missing X-API-Key header |
404 |
AWS Batch Job ID not found |
500 |
Server configuration error or unexpected error during status check |
The status response also includes a status field in the body that indicates the job state:
| Job Status |
Meaning |
PROCESSING |
Job is still running |
COMPLETE |
Job finished — transcription and diarisation are included in the response |
FAILED |
Job failed during processing |
DELETED |
Job outputs have been deleted |
NOT_FOUND |
Job ID was not found in AWS Batch |
UNKNOWN |
Status could not be determined |
ERROR |
An error occurred while checking status |
GET /queue/status
| Status |
Cause |
401 |
Invalid or missing X-API-Key header |
500 |
Server configuration error or unexpected error |
DELETE /delete/{aws_batch_job_id}
| Status |
Cause |
400 |
Missing s3_uri in request body, or invalid S3 URI |
401 |
Invalid or missing X-API-Key header |
500 |
Server configuration error or unexpected error during deletion |