メインコンテンツへスキップ
0クレジットで利用でき、すべてのプランで利用可能な2つのユーティリティエンドポイント。

ヘルスチェック

GET /health - 現在のサービスステータスを返します。認証は不要です。
curl https://api.responsibleailabs.ai/health
{
  "status": "healthy",
  "service": "rail-score-engine"
}
status
string
サービスが完全に稼働している場合は"healthy"。稼働時間の監視やロードバランサーのヘルスプローブに使用します。
service
string
常に"rail-score-engine"です。

キー検証

POST /verify - APIキーが有効でアクティブであることを検証します。キーに関連するプランと残りのクレジットを返します。
curl -X POST https://api.responsibleailabs.ai/verify \
  -H "Authorization: Bearer YOUR_RAIL_API_KEY"
{
  "valid": true,
  "plan": "pro",
  "credits_remaining": 847.5
}
valid
boolean
キーがアクティブで認可されている場合はtrue。キーが取り消されているか存在しない場合はfalse
plan
string
このキーに関連するプラン: "free""pro""business"、または"enterprise"
credits_remaining
number
現在の月間期間に残っているクレジット残高。

エラー応答

ステータス意味
401Authorizationヘッダーが欠落または無効
403キーが取り消されているか非アクティブ
503サービスが一時的に利用できません - 指数バックオフで再試行してください

SDKでの使用

from rail_score_sdk import RailScoreClient

client = RailScoreClient(api_key="YOUR_RAIL_API_KEY")

# ヘルスチェック
health = client.health()
print(health.status)  # "healthy"

# キー検証
info = client.verify()
print(info.valid)              # True
print(info.plan)               # "pro"
print(info.credits_remaining)  # 847.5

次のステップ

認証

APIキーの生成と管理方法。

クレジット & 価格

各エンドポイントのクレジットコストとプランの割り当て。