Health Check
curl --request GET \
--url https://api.vizapi.ai/v1/healthimport requests
url = "https://api.vizapi.ai/v1/health"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vizapi.ai/v1/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.vizapi.ai/v1/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.vizapi.ai/v1/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.vizapi.ai/v1/health")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vizapi.ai/v1/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": "<string>"
}Utility
Health Check
Check the health status of the API
GET
/
v1
/
health
Health Check
curl --request GET \
--url https://api.vizapi.ai/v1/healthimport requests
url = "https://api.vizapi.ai/v1/health"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vizapi.ai/v1/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.vizapi.ai/v1/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.vizapi.ai/v1/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.vizapi.ai/v1/health")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vizapi.ai/v1/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": "<string>"
}The
/health endpoint allows you to check the health status of the VizAPI.ai API. This endpoint is useful for monitoring and ensuring that the API is operational.
Request
This endpoint doesn’t require any parameters or authentication.Response
string
The health status of the API. Returns “healthy” when the API is operational.
Examples
Example Request
curl -X GET https://api.vizapi.ai/v1/health
const fetch = require('node-fetch');
async function checkHealth() {
const response = await fetch('https://api.vizapi.ai/v1/health');
const data = await response.json();
console.log(data);
}
checkHealth();
import requests
url = "https://api.vizapi.ai/v1/health"
response = requests.get(url)
data = response.json()
print(data)
Example Response
{
"status": "healthy"
}
Error Codes
| Status Code | Description |
|---|---|
| 500 | Internal Server Error - The API is experiencing issues |
| 503 | Service Unavailable - The API is temporarily unavailable |
⌘I