Error codes
In error scenarios the API will return a predefined error code along with an error message and status code to give more information on the particular error encountered.
| HTTP Status | Error Code | Error Message | Description |
|---|---|---|---|
| 400 | IA-UP-01 | Invalid file metadata provided. | Returned when the request body for POST /uploads contains invalid or missing fields (e.g., file_name). |
| 400 | IA-AN-01 | Invalid analysis types specified. | Returned when the analysis_types field contains unsupported values (e.g., not content or forensic). |
| 401 | IA-UA-01 | Authentication failed. Provide a valid API key. | Returned when the X-API-Key header is missing or invalid. |
| 403 | IA-UA-02 | You do not have permission to access this resource. | Returned when the client does not have permission to perform the requested action. |
| 404 | IA-AN-02 | Analysis ID not found. | Returned when the analysis_id in the request does not match any existing analyses. |
| 409 | IA-AN-03 | Upload not completed. Complete the file upload before starting the analysis. | Returned when an analysis is requested for an upload that hasn’t been completed. |
| 422 | IA-AN-05 | Analysis cannot be performed on this upload. | Returned when the uploaded file is invalid or unsupported for analysis. |
| 500 | IA-SV-01 | Internal server error. Please try again later. | Returned when an unexpected server-side error occurs. |
| 503 | IA-SV-02 | Service unavailable. Please try again later. | Returned when the service is temporarily unavailable (e.g., due to maintenance or overload). |