Skip to main content
GET
/
health
Health check
curl --request GET \
  --url https://api.openfiles.ai/functions/v1/api/health
{
  "status": "ok",
  "timestamp": "2023-11-07T05:31:56Z",
  "message": "OpenFiles API",
  "version": "1.0.0"
}

Documentation Index

Fetch the complete documentation index at: https://docs.openfiles.ai/llms.txt

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

​
Health Check

Check the operational status of the OpenFiles API. This endpoint is useful for monitoring, load balancers, and health checks in production systems.

​
Use Cases

  • System monitoring - Check if API is responsive
  • Load balancer health checks - Verify endpoint availability
  • Integration testing - Confirm API connectivity
  • Status dashboards - Monitor service uptime

​
Example Usage

const response = await fetch('https://api.openfiles.ai/functions/v1/api/health')
const health = await response.json()
console.log(health.status) // "ok"

​
Response

The health check returns a simple JSON response indicating the API status. 
{
  "status": "ok",
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Response

200 - application/json

Service healthy

​
status
enum<string>
required
Available options:
ok
Example:

"ok"

​
timestamp
string<date-time>
required
​
message
string
required
Example:

"OpenFiles API"

​
version
string
required
Example:

"1.0.0"