Skip to main content

​
Error Message Format

Most API errors across the Archetype platform return errors in the following JSON format to help you understand and resolve the error: 
{
  "errors": [
    {
      "code": "missing_parameter",
      "message": "Failed to find key: some_key",
      "suggestion": "Resubmit your query with the expected parameters.",
      "error_uid": "err-abc123",
    }
  ]
}
Each error has the following structure:
  • code: a specific error code, which is listed in the table below
  • message: an error message describing the problem behind the error
  • suggestion: a suggestion on how to potentially resolve or mitigate the error
  • error_uid: a unique error ID for every error, you can share this error with the Archetype team to help debug the issue
Note that there may be more than one error reported, such as a missing parameter and an invalid parameter value. Each error will return a specific code, message, suggestion, and error_uid. The following table describes Archetype error codes.

​
Error Codes

CodeDescriptionAPI or Service
invalid_file_typeThe uploaded file type is not supported. See the File Types page for the supported types.Files API
invalid_file_sizeFile size is outside the acceptable range. See the File Types page for the supported size.Files API
capacity_reachedThe file service has reached memory capacity. Delete files or wait for inactive files to be removed.Files API
file_backup_failedThe file service failed to backup the file after upload.Files API
internal_logic_errorAn internal platform logic error occurred (e.g., missing org_id, api_key, or query_id). Report this error to support.Lens API
invalid_model_parameterA model parameter has an invalid value. Either sensor_buffer_size is <= 0 or input_frame_step_size is <= 0.Lens API
sensor_log_conversion_errorFailed to convert input sensor logs to YAML format. Validate your sensor logs are YAML safe.Lens API
empty_sensor_log_errorSensor logs appear to be empty. Check your sensor log data is not empty.Lens API
max_query_size_exceededQuery size exceeds the maximum limit (default 255 MB). Decrease JSON event size or sensor buffer size.Lens API
session_ttl_reachedThe session has reached its time-to-live limit. Restart your session and increase the TTL if needed.Lens API
For supported files types and more details, refer to the File types.