Health & Status

Service health and status endpoints

Health Check

get
/health

Public endpoint - No authentication required.

Check service health and availability.

Responses
200

Service is healthy

application/json
get
/health
GET /health HTTP/1.1
Host: enterprise.bitmind.ai
Accept: */*
200

Service is healthy

{
  "status": "healthy",
  "service": "enterprise-inference-worker",
  "region": "eu-west",
  "privacy": "zero-data-retention",
  "authentication": "enterprise-only",
  "auth_methods": [
    "oauth-jwt",
    "organization-api-key"
  ],
  "timestamp": 1757026007.64969
}

Service Status

get
/status

Authenticated endpoint - Provides detailed service information and client permissions.

Returns comprehensive status information including client permissions, features, and available endpoints.

Authorizations
AuthorizationstringRequired

Primary authentication method - Required for all endpoints except /health.

Three Authentication Methods:

1. OAuth 2.0 Client Credentials (Recommended)

Get token:

curl -X POST https://enterprise.bitmind.ai/v1/oauth/token \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_ID" \
  -d "client_secret=YOUR_SECRET"

Use token:

Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...
  • Token lifetime: 1 hour
  • Fast local JWT verification (<1ms)
  • Recommended for all M2M integrations

2. OAuth + mTLS (High Security)

Get token (certificate replaces secret):

curl -X POST https://enterprise.bitmind.ai/v1/oauth/token \
  -H "X-Client-Cert: $(base64 -w 0 client.crt)" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_ID"

Use token + certificate:

Authorization: Bearer eyJhbGc...
X-Client-Cert: LS0tLS1CRUdJTi...
  • Certificate authenticates token request (no client_secret)
  • Certificate also required on all API calls
  • Required for government/healthcare/financial clients
  • Complies with RFC 8705

3. Organization API Key (Legacy)

Authorization: Bearer enterprise-YOUR_API_KEY
  • Long-lived until revoked
  • No token refresh needed
  • Simple but less secure than OAuth
Responses
200

Service status and client information

application/json
get
/status
GET /status HTTP/1.1
Host: enterprise.bitmind.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "operational",
  "service": "enterprise-inference-worker",
  "region": "eu-west",
  "client": {
    "name": "OAuth Client dae11660",
    "tier": "enterprise",
    "permissions": [
      "image_inference",
      "video_inference",
      "batch_processing"
    ]
  },
  "features": {
    "image_inference": true,
    "video_inference": true,
    "batch_processing": true,
    "zero_data_retention": true
  },
  "endpoints": {
    "image": "/image",
    "video": "/video",
    "batch_image": "/batch_image",
    "batch_video": "/batch_video"
  },
  "timestamp": 1757112866.3334515
}
PreviousAuthenticationNextImage Inference

Last updated