​
Error schema

Below we have a list of specific error types you may encounter when using the Relace API. Each scenario has a message you will get from our API along with a brief troubleshooting tip.

​
invalid_parameter

  • Status: 400
  • Message: The parameter must be a valid value.
  • Troubleshooting: Check the value and make sure it’s valid.

​
validation_error

  • Status: 400
  • Message: We found an error with one or more fields in the request.
  • Troubleshooting: The message will contain more details about what field and error were found.

​
missing_api_key

  • Status: 401
  • Message: Missing API key in the authorization header.
  • Troubleshooting: Include the following header in the request: Authorization: Bearer YOUR_API_KEY.

​
invalid_api_key

  • Status: 401
  • Message: API key is invalid.
  • Troubleshooting: Make sure the API key is correct or generate a new API key in the dashboard.

​
insufficient_permissions

  • Status: 403
  • Message: API key lacks required permissions.
  • Troubleshooting: Make sure the API key has necessary permissions for this operation.

​
not_found

  • Status: 404
  • Message: The requested resource does not exist.
  • Troubleshooting: Change your request URL to match a valid resource or check the resource ID.

​
method_not_allowed

  • Status: 405
  • Message: Method is not allowed for the requested path.
  • Troubleshooting: Change your API endpoint to use a valid method.

​
conflict

  • Status: 409
  • Message: Request conflicts with the current state of the resource.
  • Troubleshooting: Check the resource state and modify your request accordingly.

​
payload_too_large

  • Status: 413
  • Message: Request body exceeds size limits.
  • Troubleshooting: Reduce the request size. Maximum file upload size is 50MB.

​
invalid_template

  • Status: 422
  • Message: Invalid repository template URL.
  • Troubleshooting: Make sure the template URL points to a valid Git repository.

​
invalid_file_format

  • Status: 422
  • Message: File format is not supported for processing.
  • Troubleshooting: Check supported file formats and ensure your file meets the requirements.

​
missing_required_field

  • Status: 422
  • Message: The request body is missing one or more required fields.
  • Troubleshooting: Check the error message to see the list of missing fields.

​
resource_locked

  • Status: 423
  • Message: The resource is temporarily locked by another operation.
  • Troubleshooting: Wait and retry your request. The resource will be unlocked automatically.

​
rate_limit_exceeded

  • Status: 429
  • Message: Too many requests. Please limit the number of requests per minute.
  • Troubleshooting: You should read the response headers and reduce the rate at which you request the API. Wait for the rate limit to reset or contact support to increase your limit.

​
application_error

  • Status: 500
  • Message: An unexpected error occurred.
  • Troubleshooting: Try the request again later. If the error does not resolve, check our status page for service updates.

​
internal_server_error

  • Status: 500
  • Message: An unexpected error occurred.
  • Troubleshooting: Try the request again later. If the error does not resolve, check our status page for service updates.