rss — API Reference

API Documentation

GET/POST/

HTML search UI with an inlined API documentation section and a Deep Research checkbox.

ParamDescriptionRequired
query Search query optional
count Result count, 1-100, default 10 optional
content Fetch full page content (true/false) optional
ai Run AI tool-calling mode over the results (true/false) optional
deep Run the deep research pipeline instead of a plain search (true/false) optional
type web (default) or images optional
cache Set to false to bypass all cache layers optional

/?query=quantum+computing&count=10

GET/search

JSON search API.

ParamDescriptionRequired
query Search query required
count Result count, 1-100, default 10 optional
content Fetch full page content (true/false) optional
ai Run AI tool-calling mode (true/false) optional
deep Run deep research (true/false) optional
type web (default) or images optional
cache Set to false to bypass cache optional

/search?query=rust+vs+swift&count=5

GET/POST/chat

Direct LLM chat completion, no tool-calling, 2-week cache.

ParamDescriptionRequired
prompt User prompt required
system Optional system message (a fixed preamble is always prepended) optional
json Force JSON-only output (true/false) optional
cache Set to false to bypass cache optional

/chat?prompt=Summarize+the+Rust+borrow+checker

GET/POST/describe

Vision describe, by URL query param or uploaded image bytes.

ParamDescriptionRequired
url Image URL to describe optional
cache Set to false to bypass cache optional

/describe?url=https://example.com/image.png

GET/health

Provider/image-provider stats and cache entry counts.

/health

GET/stats

SVG-rendered analytics dashboard.

ParamDescriptionRequired
json Return raw aggregated metrics as JSON instead of HTML optional

/stats

GET/about

Full API documentation (same content block as the bottom of /).

/about

GET/openapi.json

Machine-readable OpenAPI 3.0 document.

/openapi.json