> ## 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.

# System Status

Get system status including initialization state and current user information.

<Note>
  For unauthenticated health checks, use the `/health` endpoint instead.
</Note>

## Authentication

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

## Response

<ResponseField name="status" type="string">
  Response status (`ok` or `error`)
</ResponseField>

<ResponseField name="result" type="object">
  System status information

  <Expandable title="Status Object">
    <ResponseField name="initialized" type="boolean">
      Whether the system has completed initialization
    </ResponseField>

    <ResponseField name="user" type="string">
      Current user ID from the API key
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="time" type="number">
  Request processing time in seconds
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET http://localhost:1933/api/v1/system/status \
    -H "X-API-Key: your-key"
  ```

  ```python Python SDK theme={null}
  # Get system status
  status = client.observer.system
  print(status)
  ```

  ```bash CLI theme={null}
  openviking status
  ```
</CodeGroup>

<ResponseExample>
  ```json Response theme={null}
  {
    "status": "ok",
    "result": {
      "initialized": true,
      "user": "alice"
    },
    "time": 0.05
  }
  ```
</ResponseExample>

## Health Check (No Auth)

For basic health checks without authentication (e.g., load balancers, monitoring):

```bash theme={null}
curl -X GET http://localhost:1933/health
```

Response:

```json theme={null}
{
  "status": "ok"
}
```

## Readiness Probe

For Kubernetes readiness probes that check all subsystems:

```bash theme={null}
curl -X GET http://localhost:1933/ready
```

Response (200 OK):

```json theme={null}
{
  "status": "ready",
  "checks": {
    "agfs": "ok",
    "vectordb": "ok",
    "api_key_manager": "ok"
  }
}
```

Response (503 Service Unavailable):

```json theme={null}
{
  "status": "not_ready",
  "checks": {
    "agfs": "ok",
    "vectordb": "error: connection refused",
    "api_key_manager": "ok"
  }
}
```

## Related Endpoints

* [System Metrics](/api/system/metrics) - Detailed component metrics
* [Wait for Processing](/api/system/wait) - Wait for async operations