Health check

curl --request GET \
  --url https://api.openfiles.ai/functions/v1/api/health

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.openfiles.ai/functions/v1/api/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.openfiles.ai/functions/v1/api/health"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.openfiles.ai/functions/v1/api/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "status": "ok",
  "timestamp": "2023-11-07T05:31:56Z",
  "message": "OpenFiles API",
  "version": "1.0.0"
}

GET

health

Health check

curl --request GET \
  --url https://api.openfiles.ai/functions/v1/api/health

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.openfiles.ai/functions/v1/api/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.openfiles.ai/functions/v1/api/health"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.openfiles.ai/functions/v1/api/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "status": "ok",
  "timestamp": "2023-11-07T05:31:56Z",
  "message": "OpenFiles API",
  "version": "1.0.0"
}

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"

import requests

response = requests.get('https://api.openfiles.ai/functions/v1/api/health')
health = response.json()
print(health['status'])  # "ok"

curl 'https://api.openfiles.ai/functions/v1/api/health'

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"

Error Handling Write file

​Health Check

​Use Cases

​Example Usage

​Response

Response

Health Check

Use Cases

Example Usage

Response