Health

GET/healthNo authentication

A lightweight check you can call from a monitor or a deployment script. It does not need an API key and does not use your quota. The endpoint also answers HEAD, which some uptime monitors use. A public status page is available at stats.uptimerobot.com.

Request

No parameters and no authentication.

Response

Field Type Description
status string healthy, or degraded when the database does not answer
version string The API version
service string The service name
database string ok, or unhealthy: … with the reason
timestamp datetime The time of the answer 
{
  "status": "healthy",
  "version": "1.0.0",
  "service": "DocSlice Document Intelligence API",
  "database": "ok",
  "timestamp": "2026-10-12T09:30:00.123456"
}

Errors

Status When
503 The database does not answer: the body is the usual answer with status: "degraded" and the reason in database

Examples

Check that the API is up
curl -s https://api.docslice.app/health

import json
import requests

response = requests.get("https://api.docslice.app/health", timeout=30)
print(json.dumps(response.json(), indent=2))

fetch("https://api.docslice.app/health")
  .then((response) => response.json())
  .then((data) => console.log(JSON.stringify(data, null, 2)));

<?php
echo file_get_contents('https://api.docslice.app/health');