Service

Unauthenticated endpoints for health checks and discovery.

Two unauthenticated endpoints for health checks and discovery.

#Health

GET/healthNo authentication

Liveness of the API process, with its version and environment. Use it for uptime checks and before pointing a dashboard at a self-hosted API.

Returns

{status, service, version, env}.

print(client.health())

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

200 OKResponse

{
  "status": "ok",
  "service": "kaimei-api",
  "version": "0.1.0",
  "env": "production"
}

#API index

GET/v1No authentication

The resource paths and the built-in reference models available on this server.

Returns

{name, version, docs, resources, builtin_models}.

curl https://api.kaimei.ai/v1

200 OKResponse

{
  "name": "Kaimei API",
  "version": "v1",
  "docs": "/docs",
  "resources": {
    "auth": "/v1/auth",
    "organization": "/v1/organization",
    "api_keys": "/v1/api-keys",
    "models": "/v1/models",
    "projects": "/v1/projects",
    "predictions": "/v1/predictions",
    "explanations": "/v1/explanations",
    "analyses": "/v1/analyses",
    "insights": "/v1/insights"
  },
  "builtin_models": [
    {
      "name": "credit-risk",
      "title": "Credit risk scorer",
      "task": "binary_classification",
      "features": 9
    },
    {
      "name": "energy-demand",
      "title": "Grid energy demand forecaster",
      "task": "regression",
      "features": 7
    },
    {
      "name": "churn-risk",
      "title": "Subscription churn network",
      "task": "binary_classification",
      "features": 6
    },
    {
      "name": "equity-alpha",
      "title": "Equity alpha network",
      "task": "regression",
      "features": 8
    },
    {
      "name": "cats-dogs",
      "title": "Cats and dogs network",
      "task": "binary_classification",
      "features": 1
    }
  ]
}