Skip to main content

Authentication

The Gauzr API authenticates every request with an API key sent as a bearer token.

curl https://api.gauzr.com/v1/inspections \
-H "Authorization: Bearer $GAUZR_API_KEY"

Keys and environments

Keys are scoped to an environment so test traffic never touches production data.

PrefixEnvironmentNotes
sk_test_…TestInspections are simulated; no billing.
sk_live_…LiveReal captures, real reports, billable.
warning

Secret keys grant full access to your account. Keep them server-side, never ship them in a browser or mobile bundle, and rotate immediately if one leaks.

Rotating a key

Create a new key in the dashboard, deploy it, then revoke the old one. Revocation takes effect immediately — in-flight requests using the revoked key return 401.

Errors

A missing, malformed, or revoked key returns 401 Unauthorized:

{
"error": {
"type": "authentication_error",
"message": "No valid API key provided."
}
}

See Errors for the full error model.