Health check
curl --request GET \
--url https://api.vidnavigator.com/v1/healthimport requests
url = "https://api.vidnavigator.com/v1/health"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vidnavigator.com/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.vidnavigator.com/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.vidnavigator.com/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.vidnavigator.com/v1/health")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vidnavigator.com/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": "success",
"message": "<string>",
"version": "<string>",
"endpoints": [
{
"path": "<string>",
"method": "<string>",
"description": "<string>",
"auth_required": true
}
]
}System
API Health Check
Check API health and get endpoint information
GET
/
health
Health check
curl --request GET \
--url https://api.vidnavigator.com/v1/healthimport requests
url = "https://api.vidnavigator.com/v1/health"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vidnavigator.com/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.vidnavigator.com/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.vidnavigator.com/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.vidnavigator.com/v1/health")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vidnavigator.com/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": "success",
"message": "<string>",
"version": "<string>",
"endpoints": [
{
"path": "<string>",
"method": "<string>",
"description": "<string>",
"auth_required": true
}
]
}Check API health status and get a list of all available endpoints. This endpoint does not require authentication.
Example Request
cURL
curl "https://api.vidnavigator.com/v1/health"
Success Response
{
"status": "success",
"message": "API is healthy",
"version": "1.0.0",
"endpoints": [
{ "path": "/transcript", "method": "POST", "description": "Get transcript for any supported video (incl. YouTube)", "auth_required": true },
{ "path": "/transcribe", "method": "POST", "description": "Transcribe online videos", "auth_required": true },
{ "path": "/analyze/video", "method": "POST", "description": "Analyze online video", "auth_required": true },
{ "path": "/analyze/file", "method": "POST", "description": "Analyze uploaded file", "auth_required": true },
{ "path": "/extract/video", "method": "POST", "description": "Extract structured data from online video", "auth_required": true },
{ "path": "/extract/file", "method": "POST", "description": "Extract structured data from uploaded file", "auth_required": true },
{ "path": "/youtube/search", "method": "POST", "description": "Search YouTube for videos", "auth_required": true },
{ "path": "/tiktok/profile", "method": "POST", "description": "Submit a TikTok profile scrape", "auth_required": true },
{ "path": "/tiktok/profile/{task_id}", "method": "GET", "description": "Get TikTok profile scrape result", "auth_required": true },
{ "path": "/tiktok/search", "method": "POST", "description": "Submit a TikTok keyword search", "auth_required": true },
{ "path": "/tiktok/search/{task_id}", "method": "GET", "description": "Get TikTok keyword search result", "auth_required": true },
{ "path": "/search/file", "method": "POST", "description": "Search uploaded files", "auth_required": true },
{ "path": "/files", "method": "GET", "description": "List uploaded files", "auth_required": true },
{ "path": "/file/{file_id}", "method": "GET", "description": "Get file info and transcript", "auth_required": true },
{ "path": "/file/{file_id}/url", "method": "GET", "description": "Get temporary file URL", "auth_required": true },
{ "path": "/upload/file", "method": "POST", "description": "Upload a file", "auth_required": true },
{ "path": "/file/{file_id}/retry", "method": "POST", "description": "Retry failed file processing", "auth_required": true },
{ "path": "/file/{file_id}/cancel", "method": "POST", "description": "Cancel file processing", "auth_required": true },
{ "path": "/file/{file_id}/delete", "method": "DELETE", "description": "Delete a file", "auth_required": true },
{ "path": "/namespaces", "method": "GET", "description": "List namespaces", "auth_required": true },
{ "path": "/namespaces", "method": "POST", "description": "Create a namespace", "auth_required": true },
{ "path": "/namespaces/{namespace_id}", "method": "PUT", "description": "Rename a namespace", "auth_required": true },
{ "path": "/namespaces/{namespace_id}", "method": "DELETE", "description": "Delete a namespace", "auth_required": true },
{ "path": "/file/{file_id}/namespaces", "method": "PUT", "description": "Update file namespace assignments", "auth_required": true },
{ "path": "/usage", "method": "GET", "description": "Get usage statistics", "auth_required": true },
{ "path": "/health", "method": "GET", "description": "Health check", "auth_required": false }
]
}
⌘I