1. Authentication Scheme#
This Open API uses a project-level API key.
Send the following header on every request:Value: <YOUR_PROJECT_API_KEY>
2. Common Authentication Failures#
{
"error": true,
"code": 401,
"message": "x-api-key header is required"
}
2.2 Invalid Key#
{
"error": true,
"code": 401,
"message": "Invalid project API key"
}
2.3 Inactive Key#
{
"error": true,
"code": 403,
"message": "Project API key is not active"
}
2.4 Expired Key#
{
"error": true,
"code": 401,
"message": "Project API key has expired"
}
3. Security Recommendations#
Do not expose x-api-key directly in browser/front-end code.
Do not log full API keys (log only masked prefixes/suffixes).
Modified at 2026-03-29 06:42:30