Health check
GET /health - returns the current service status. No authentication required.
"healthy" when the service is fully operational. Use this for uptime monitoring and load balancer health probes.Always
"rail-score-engine".Key verification
POST /verify - verifies that an API key is valid and active. Returns the plan and remaining credits for the key.
true if the key is active and authorized. false if the key is revoked or does not exist.The plan associated with this key:
"free", "pro", "business", or "enterprise".Credit balance remaining in the current monthly period.
Error responses
| Status | Meaning |
|---|---|
401 | Missing or invalid Authorization header |
403 | Key is revoked or inactive |
503 | Service temporarily unavailable - retry with exponential backoff |
Usage in SDKs
What’s next
Authentication
How to generate and manage API keys.
Credits & Pricing
Credit costs for each endpoint and plan allocations.