System Status

GET

api

system

status

System Status

curl --request GET \
  --url https://api.example.com/api/v1/system/status

<?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))

}

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.

For unauthenticated health checks, use the /health endpoint instead.

Authentication

Requires API key authentication via X-API-Key header.

Response

string

Response status (ok or error)

object

System status information

Show Status Object

boolean

Whether the system has completed initialization

string

Current user ID from the API key

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

Response:

{
  "status": "ok"
}

Readiness Probe

For Kubernetes readiness probes that check all subsystems:

curl -X GET http://localhost:1933/ready

Response (200 OK):

{
  "status": "ready",
  "checks": {
    "agfs": "ok",
    "vectordb": "ok",
    "api_key_manager": "ok"
  }
}

Response (503 Service Unavailable):

{
  "status": "not_ready",
  "checks": {
    "agfs": "ok",
    "vectordb": "error: connection refused",
    "api_key_manager": "ok"
  }
}

System Metrics - Detailed component metrics
Wait for Processing - Wait for async operations

⌘I

System Status

curl --request GET \
  --url https://api.example.com/api/v1/system/status

<?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))

}

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
}

Overview

Resources

Filesystem

Search & Retrieval

Sessions

Skills

System

Admin

Authentication

Response

Example

Health Check (No Auth)

Readiness Probe

​Authentication

​Response

​Example

​Health Check (No Auth)

​Readiness Probe

​Related Endpoints

Authentication

Response

Example

Health Check (No Auth)

Readiness Probe

Related Endpoints