Health Check

health

Returns whether the server is running, which embedding provider and model are configured, and how many items are stored versus the global cap (default 100,000).

client.health() -> dict[str, Any]

API: GET /health — see Health

Examples

from moorcheh import MoorchehClient, MoorchehApiError

with MoorchehClient("http://localhost:8080") as client:
    health = client.health()

    print(health["status"])              # ok
    print(health["embedding_provider"])  # ollama, openai, or cohere
    print(health["model"])               # e.g. embed-v4.0
    print(health["items"])               # current count across all namespaces
    print(health["max_items"])           # 100000
    print(health["remaining"])           # max_items - items

Returns

string

Server health. "ok" when the API is running and reachable.

string

Active provider: ollama, openai, or cohere.

string

Embedding model id for the configured provider. Used for text documents and text search queries.

number

Total number of stored items across all namespaces (text documents + vectors).

number

Global storage cap for this instance. Default is 100000.

number

How many new items you can still add: max_items - items. Uploads that would exceed this return 409.

Example return value

{
  "status": "ok",
  "model": "nomic-embed-text",
  "items": 7,
  "max_items": 100000,
  "remaining": 99993,
}

Field order in the response may vary; all fields above are always present on success.

Error Handling

Non-2xx responses raise MoorchehApiError (for example if the server is not running or unreachable).

from moorcheh import MoorchehApiError

try:
    with MoorchehClient() as client:
        health = client.health()
except MoorchehApiError as e:
    print(e.status_code, e.body)

API: Health
CLI: moorcheh status
Python: documents.upload() — 409 quota errors include the same fields in MoorchehApiError.body

Getting Started

System

Namespace Management

Search

AI Generation

Data Operations

File storage

Items

health

Examples

Returns

Error Handling

​health

​Examples

​Returns

​Error Handling

​Related Operations

health

Examples

Returns

Error Handling

Related Operations