Skip to main content

Errors

Gauzr uses conventional HTTP status codes and a consistent error body. 2xx means success, 4xx means the request was rejected (and usually tells you how to fix it), and 5xx means something failed on our side.

Error shape

{
"error": {
"type": "invalid_request_error",
"message": "vehicle.vin is not a valid VIN.",
"param": "vehicle.vin"
}
}
FieldDescription
typeMachine-readable category (see below).
messageHuman-readable explanation. Safe to log; don't parse.
paramThe offending field, when the error is field-specific.

Status codes

StatusTypeMeaning
400invalid_request_errorMalformed request or missing parameter.
401authentication_errorMissing, invalid, or revoked API key.
403permission_errorKey lacks access to the resource.
404not_found_errorNo such resource.
409conflict_errorThe resource is in a state that forbids the action.
422validation_errorWell-formed request that failed validation.
429rate_limit_errorToo many requests — back off and retry.
500api_errorSomething went wrong on our end.

Rate limits

When you exceed a limit you get 429 with a Retry-After header (seconds). Respect it and retry with exponential backoff. Idempotency keys make those retries safe on POST requests — see the API Reference.