API Reference / System

Check service health

GET/v1/health

Whether the service and its parts are up: status is ok, or degraded when a part is unavailable. No authentication needed.

Authentication

None. This endpoint does not need an API key.

200 Success.

JSON

{
  "request_id": "req_8f14e45fceea167a5a36dedd",
  "status": "ok",
  "version": "1.0.0",
  "database": "ok",
  "inference": "ok"
}

Status	Meaning
429	Too many requests or too many operations at the same time. Wait for the number of seconds in Retry-After.
500	Something went wrong on our side. No credits were used.

Error bodies share one shape with a stable error.code; see Errors for every code and how to fix it.

cURL

curl "https://platform.detectif.ai/v1/health"

Python

import os

import requests

resp = requests.get(
    "https://platform.detectif.ai/v1/health",
    timeout=30,
)
print(resp.status_code, resp.json())

JavaScript

const res = await fetch("https://platform.detectif.ai/v1/health");
console.log(res.status, await res.json());