FAQ & Troubleshooting
Troubleshooting
1min
Troubleshooting Guide: Common API Errors and Solutions
This troubleshooting guide provides solutions to common errors encountered while using the AIShield API. If you are facing any of the following issues, follow the steps mentioned below to resolve them.
- Error: "Org-Id missing"
- Reason: The API call requires an Org-Id parameter in the header, which uniquely identifies each User or Organization subscribed to the AIShield Product.
- Solution: Make sure to include the Org-Id parameter in the header of your API request. If you haven't subscribed to AIShield Product yet, please do so to obtain a valid Org-Id.
- Error: "Subscription plan has expired. Please contact AIShield support"
- Reason: The subscription plan associated with the provided Org-Id has expired, and you can no longer access the API services.
- Solution: Contact the AIShield Support Team to renew your subscription plan and regain access to the API services.
- Error: "Please check, except required parameters no other parameters should be provided for performing model registration"
- Reason: When performing model registration, you should only include the accepted parameters in the payload. Including any additional parameters will result in this error.
- Solution: Review the documentation to ensure that you are sending only the required parameters during model registration. Remove any extra parameters from the payload to resolve the issue.
- Error: "Invalid Org-ID value specified"
- Reason: The Org-Id value provided in the API call is incorrect or invalid.
- Solution: Double-check the Org-Id value provided to you by the AIShield team. If you believe the Org-Id is correct, but the error persists, contact the AIShield Support Team for assistance.
- Error: "Model file missing" or "Data file missing"
- Reason: When performing model registration, you must upload both the Model and Data files using the provided URLs. Not providing these files will result in this error when attempting to perform model analysis API calls.
- Solution: Ensure that you have uploaded both the Model and Data files to the specified URLs before making model analysis API calls. Uploading the required files will resolve the issues.
- Error: "Forbidden"
- Reason: The API call requires an x-api-key parameter in the header for authentication. The x-api-key parameter is obtained using the get_aws_api_key API.
- Solution: Include the x-api-key parameter in the header of your API request to authenticate your access. If you haven't obtained the x-api-key yet, use the get_aws_api_key API to acquire it.
If you encounter any other issues or need further assistance, please don't hesitate to reach out to the AIShield Support Team. They will be glad to assist you with any API-related problems.