Skip to main content
GET
/
api
/
v1
/
system
/
status
System Status
curl --request GET \
  --url https://api.example.com/api/v1/system/status
{
  "status": "ok",
  "result": {
    "initialized": true,
    "user": "alice"
  },
  "time": 0.05
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/volcengine/OpenViking/llms.txt

Use this file to discover all available pages before exploring further.

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

​
status
string
Response status (ok or error)
​
result
object
System status information
​
time
number
Request processing time in seconds

​
Example

curl -X GET http://localhost:1933/api/v1/system/status \
  -H "X-API-Key: your-key"

{
  "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"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us