Skip to main content

Documentation Index

Fetch the complete documentation index at: https://clearlayer.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Check health

GET /v1/health Returns the current status of the API and its database connection. Use this endpoint to verify the API is reachable before making authenticated requests. No API key is required.

​
Response fields

​
status
string
"healthy" if the database is reachable, "unhealthy" if not.
​
timestamp
string
ISO 8601 timestamp of when the check was performed.

​
Example

curl https://clearlayer-api-production.up.railway.app/v1/health

​
200 — Healthy

{
  "status": "healthy",
  "timestamp": "2024-01-15T10:30:00.000Z"
}

​
503 — Unhealthy

Returned when the database is unreachable. If you receive this response, the API is up but dependent services are degraded. 
{
  "status": "unhealthy",
  "timestamp": "2024-01-15T10:30:00.000Z"
}