Health & Liveness

The platform exposes a liveness / health-check endpoint for monitoring, pre-flight checks, and smoke tests.

Full schemas and try-it-out forms live in the interactive API Reference.

Authentication

All endpoints require a Bearer token:

Authorization: Bearer YOUR_API_KEY

See Getting Started → Authentication.

Response envelope

Every endpoint returns the canonical envelope: { "success": true, "data": { ... } } on success or the standard error envelope on error.

Endpoint summary

Method	Path	Description	Sync/Async
GET	/health	Component health check	Sync

The health probe is not enforced by the per-minute rate limiter today — it is not classified under any configured category and only the gateway-level throttle applies. See Developer Guide → Usage quotas and rate limits.

An additional GET /test liveness probe is also available; it returns a fixed greeting payload regardless of downstream service health. Browse it on the API Reference page.

---

GET /health — Platform health

Reports the status of downstream services. With no category parameter, returns a simple "alive" greeting. With category=autogenerator or category=scim, reports per-component status and returns 503 if any required component is unhealthy.

Query parameters

Parameter	Type	Required	Description
category	string (autogenerator or scim)	no	Component group to check. Omit for a generic liveness response.

Example

cURL

curl "https://api.prezent.ai/health?category=autogenerator" \
  -H "Authorization: Bearer $PREZENT_API_KEY"

Python

import os
import requests

url = "https://api.prezent.ai/health"
headers = {
    "Authorization": f"Bearer {os.environ['PREZENT_API_KEY']}",
}
params = {"category": "autogenerator"}

response = requests.get(url, headers=headers, params=params)
body = response.json()
print(body)

Node.js

const axios = require('axios');

const checkHealth = async () => {
  const { data } = await axios.get(
    'https://api.prezent.ai/health',
    {
      params: { category: 'autogenerator' },
      headers: {
        Authorization: `Bearer ${process.env.PREZENT_API_KEY}`
      }
    }
  );

  console.log(data);
  return data;
};

checkHealth();

Success response (200)

{
  "success": true,
  "data": {
    "message": "All AutoGenerator components healthy.",
    "category": "autogenerator",
    "services": [
      { "name": "slide-generator", "status": "ok" },
      { "name": "asset-store", "status": "ok" }
    ],
    "timestamp": "2026-05-18T10:14:00Z"
  }
}

Degraded response (503)

When any required component is unhealthy:

{
  "success": false,
  "data": null,
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "One or more AutoGenerator components are unhealthy.",
    "details": {
      "services": [
        { "name": "slide-generator", "status": "degraded", "detail": "..." }
      ]
    }
  }
}

---

Errors

Common error codes:

• 401 — INVALID_API_KEY, EXPIRED_API_KEY, UNAUTHORIZED.
• 429 — RATE_LIMIT_EXCEEDED, TOO_MANY_REQUESTS.
• 500 — INTERNAL_SERVER_ERROR.
• 503 — SERVICE_UNAVAILABLE (component degraded).
• 504 — GATEWAY_TIMEOUT.

See the full catalog in Developer Guide → Error codes.