Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/StarTrail-org/PixelRAG/llms.txt

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

The /status endpoint returns a snapshot of the server’s current state, including the total number of indexed vectors, the embedding dimension, FAISS index parameters, the model name, and the sizes and build time of the index files on disk. Use it to verify that a server is pointing at the expected index and to retrieve the default nprobe value for search planning. Method: GET
Path: /status
Request body: none

​
Response

​
total_vectors
integer
Total number of embedding vectors in the loaded index.
​
dimension
integer
Embedding dimensionality. All query embeddings passed to /search must match this dimension.
​
nlist
integer
Number of IVF clusters in the FAISS index. Larger values improve search speed on very large indexes.
​
nprobe
integer
Default number of IVF cells visited per query. Can be overridden per request via the nprobe field in /search.
​
model
string
HuggingFace model name or local path used by the server to embed queries (e.g. Qwen/Qwen3-VL-Embedding-2B).
​
index_dir
string
Filesystem path to the directory containing index.faiss, metadata.npz, and summary.json.
​
tiles_dir
string
Filesystem path to the directory containing rendered tile images. May be empty when on-demand rendering is enabled.
​
index_built_at
string
ISO 8601 timestamp (UTC) of when the index file was last modified.
​
index_size_bytes
integer
Size of index.faiss in bytes.
​
metadata_size_bytes
integer
Size of metadata.npz in bytes.

​
Example

curl https://api.pixelrag.ai/status

{
  "total_vectors": 82800000,
  "dimension": 2048,
  "nlist": 4096,
  "nprobe": 128,
  "model": "Qwen/Qwen3-VL-Embedding-2B",
  "index_dir": "./index/search_index_normed_v2",
  "tiles_dir": "./tiles",
  "index_built_at": "2025-04-10T08:32:11+00:00",
  "index_size_bytes": 676458192896,
  "metadata_size_bytes": 2642903040
}

​
Health Check

For a lightweight liveness probe — such as a load balancer health check — use GET /health instead of /status. It returns immediately without reading any index state: 
curl https://api.pixelrag.ai/health

{"status": "ok"}
Use /health for automated uptime monitoring and /status for human-readable diagnostics. The /health endpoint never blocks on index I/O and is always fast.

Build docs developers (and LLMs) love

Get started for freeTalk to us