System
System Status
GET
/
api
/
v1
/
system
/
status
System Status
curl --request GET \
--url https://api.example.com/api/v1/system/statusimport requests
url = "https://api.example.com/api/v1/system/status"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/system/status', 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.example.com/api/v1/system/status",
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.example.com/api/v1/system/status"
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.example.com/api/v1/system/status")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/system/status")
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",
"result": {
"initialized": true,
"user": "alice"
},
"time": 0.05
}
Get system status including initialization state and current user information.
Response:
Response (200 OK):
Response (503 Service Unavailable):
For unauthenticated health checks, use the
/health endpoint instead.Authentication
Requires API key authentication viaX-API-Key header.
Response
string
Response status (
ok or error)object
number
Request processing time in seconds
Example
curl -X GET http://localhost:1933/api/v1/system/status \
-H "X-API-Key: your-key"
# Get system status
status = client.observer.system
print(status)
openviking status
{
"status": "ok",
"result": {
"initialized": true,
"user": "alice"
},
"time": 0.05
}
Health Check (No Auth)
For basic health checks without authentication (e.g., load balancers, monitoring):curl -X GET http://localhost:1933/health
{
"status": "ok"
}
Readiness Probe
For Kubernetes readiness probes that check all subsystems:curl -X GET http://localhost:1933/ready
{
"status": "ready",
"checks": {
"agfs": "ok",
"vectordb": "ok",
"api_key_manager": "ok"
}
}
{
"status": "not_ready",
"checks": {
"agfs": "ok",
"vectordb": "error: connection refused",
"api_key_manager": "ok"
}
}
Related Endpoints
- System Metrics - Detailed component metrics
- Wait for Processing - Wait for async operations
System Status
curl --request GET \
--url https://api.example.com/api/v1/system/statusimport requests
url = "https://api.example.com/api/v1/system/status"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/system/status', 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.example.com/api/v1/system/status",
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.example.com/api/v1/system/status"
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.example.com/api/v1/system/status")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/system/status")
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",
"result": {
"initialized": true,
"user": "alice"
},
"time": 0.05
}