Health & Verify

Two utility endpoints that cost 0 credits and are available to all plans.

Health check

GET /health - returns the current service status. No authentication required.

curl https://api.responsibleailabs.ai/health

{
  "status": "healthy",
  "service": "rail-score-engine"
}

status

string

"healthy" when the service is fully operational. Use this for uptime monitoring and load balancer health probes.

service

string

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.

curl -X POST https://api.responsibleailabs.ai/verify \
  -H "Authorization: Bearer YOUR_RAIL_API_KEY"

{
  "valid": true,
  "auth_type": "api_key",
  "org_id": "org_1a2b3c",
  "org_name": "Acme",
  "plan": "pro",
  "email": "you@acme.com",
  "balance": 847.5,
  "credits_used": 152.5
}

valid

boolean

true if the key/token is active and authorized.

auth_type

string

"api_key" or "jwt", depending on how the request authenticated.

plan

string

The plan associated with this credential: "free", "pro", "business", or "enterprise".

balance

number

Credit balance remaining in the current monthly period. null (with a balance_error field) if the credits service was unreachable when this call was made — valid is unaffected.

Error responses

Status	Meaning
`401`	Missing or invalid `Authorization` header
`403`	Key is revoked or inactive
`503`	Service temporarily unavailable - retry with exponential backoff

Health check in the SDKs

Both SDKs wrap /health:

from rail_score_sdk import RailScoreClient

client = RailScoreClient(api_key="YOUR_RAIL_API_KEY")

health = client.health()
print(health.status)  # "healthy"

import { RailScoreClient } from "@responsible-ai-labs/rail-score";

const client = new RailScoreClient({ apiKey: "YOUR_RAIL_API_KEY" });

const health = await client.health();
console.log(health.status); // "healthy"

Neither SDK currently wraps /verify with a dedicated method — call it directly (as in the curl example above) if you need a pre-flight credential/balance check.

Reference

Scoring

Compliance

Agent

Introspection & status

Health check

Key verification

Error responses

Health check in the SDKs

What’s next

Authentication

Credits & Pricing

​Health check

​Key verification

​Error responses

​Health check in the SDKs

​What’s next

Authentication

Credits & Pricing

Health check

Key verification

Error responses

Health check in the SDKs

What’s next