VidVeil API Documentation

OpenAPI 3.0 - Privacy-respecting meta search API

Endpoints

MethodPathSummaryDescription
GET/api/v1/healthzHealth checkGet API health status (per PART 13)
GET/api/v1/searchSearch videosSearch across multiple adult video engines
GET/healthzKubernetes healthKubernetes-style health endpoint
GET/search.atomAtom feedSearch results as Atom 1.0 feed
GET/.well-known/vidveil.jsonWell-known metadataMachine-readable server metadata and capability discovery
GET/api/v1/admin/analyticsSearch analyticsAggregate search analytics — privacy-safe (no per-user data). Requires admin token.
PATCH/api/v1/admin/engines/{name}Toggle engineEnable or disable a search engine by name. Requires admin token.
POST/api/v1/admin/engines/{name}/resetReset circuit breakerManually reset the circuit breaker for a search engine. Requires admin token.
POST/api/v1/search/batchBatch searchSearch multiple queries in one request (max 5 queries)
GET/search.rssRSS feedSearch results as RSS 2.0 feed
GET/api/v1/enginesList enginesGet all search engines with status and privacy scores
GET/api/v1/engines/healthEngine healthGet health status including circuit breaker state for each engine