Check API health
curl --request GET \
--url https://api.headlessagents.ai/healthimport requests
url = "https://api.headlessagents.ai/health"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.headlessagents.ai/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.headlessagents.ai/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.headlessagents.ai/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))
}HttpResponse<String> response = Unirest.get("https://api.headlessagents.ai/health")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.headlessagents.ai/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": "healthy"
}Endpoints
Health Check
Simple endpoint to check if the API is up and running. No authentication required.
GET
/
health
Check API health
curl --request GET \
--url https://api.headlessagents.ai/healthimport requests
url = "https://api.headlessagents.ai/health"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.headlessagents.ai/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.headlessagents.ai/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.headlessagents.ai/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))
}HttpResponse<String> response = Unirest.get("https://api.headlessagents.ai/health")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.headlessagents.ai/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": "healthy"
}Check if the API is up and running. This endpoint does not require authentication.
Endpoint
GET /health
Response
string
required
Will return “healthy” if the API is functioning properly
{
"status": "healthy"
}
Response
200 - application/json
API is healthy
Available options:
healthy ⌘I