Documentation

Utility Endpoints

System utilities for health checks, metrics, and monitoring. All utility endpoints are free.

Base URL

https://api.responsibleailabs.ai

All utility endpoints use this base URL.

No Credits Required

All utility endpoints are free and don't consume any credits from your account.

API Status

GET /

Response:
{
  "service": "RAIL Score API",
  "version": "1.0.0",
  "status": "running"
}

Simple endpoint to verify the API is online. No authentication required.

Health Check

GET /health/check

Response:
{
  "status": "healthy"
}

Fast health check for connection testing and monitoring. No authentication required.

Verify API Key

POST /verify
Authorization: Bearer your-api-key

Response (Success):
{
  "status": "verified",
  "message": "API key is valid",
  "tier": "free"
}

Response (Invalid Key):
{
  "detail": "Invalid API key"
}

Verify your API key is valid and active. Returns your plan tier without consuming credits.

API Metrics

GET /railscore/v1/metrics

Response:
{
  "total_requests": 15234,
  "avg_response_time_ms": 245,
  "success_rate": 0.998
}

Available Utilities

API Status

GET /

Verify API is online

Health Check

GET /health/check

Fast connection test

Verify API Key

POST /verify

Test your API key

Requires Auth

API Metrics

GET /railscore/v1/metrics

Get usage metrics

Pricing Info

GET /railscore/v1/pricing

Current endpoint pricing

Queue Stats

GET /railscore/v1/queue/stats

Queue status

Requires Auth