A retrieval API for querying and filtering documents based on natural language queries and metadata
Full LLM thinking from the 4-phase benchmark pipeline.
{
"service_type": "platform",
"base_url": "https://www.openindex.ai",
"auth_method": "api_key",
"auth_config": {
"header": "Authorization",
"scheme": "Bearer",
"web_login": "Google (device flow for CLI)",
"api_key_location": "https://www.openindex.ai/account",
"notes": "Read/search/edit are free and require no account. Authenticated actions (creating pages, comments, renting, MCP) use a Bearer API key obtained after Google login."
},
"endpoints": [
{
"name": "Index data",
"path": "/api/index",
"method": "GET",
"description": "JSON with categories, hubs, wanted pages, tags, recent pages"
},
{
"name": "Search",
"path": "/api/search?q=example",
"method": "GET",
"description": "Hybrid search (BM25 + semantic embeddings + rent boost), JSON results with ranking signals"
},
{
"name": "List pages",
"path": "/api/pages?sort=recent",
"method": "GET",
"description": "List pages with sorting"
},
{
"name": "Create page",
"path": "/api/pages",
"method": "POST",
"description": "Create a page (costs $0.10 in credits)"
},
{
"name": "Read/Edit/Delete page",
"path": "/api/pages/{slug}",
"method": "GET/PUT/DELETE",
"description": "Manage a specific page"
},
{
"name": "Markdown export",
"path": "/page/<slug>.md",
"method": "GET",
"description": "Any page as markdown with front matter (backlinks, tags, links)"
},
{
"name": "MCP endpoint",
"path": "/api/mcp",
"method": "POST",
"description": "Streamable HTTP MCP server, Bearer API key"
},
{
"name": "MCP server card",
"path": "/api/mcp/server-card",
"method": "GET",
"description": "Pre-connection metadata (SEP-2127)"
},
{
"name": "OpenAPI description",
"path": "/openapi.json",
"method": "GET",
"description": "OpenAPI 3.1 description of every endpoint"
},
{
"name": "AI catalog",
"path": "/.well-known/ai-catalog.json",
"method": "GET",
"description": "AI catalog well-known file"
},
{
"name": "Sitemap",
"path": "/sitemap.xml",
"method": "GET",
"description": "Every indexable URL"
}
],
"pricing_model": {
"type": "freemium",
"details": {
"credits": "1 credit = 1 US cent",
"new_account_bonus": "$1.00",
"create_page": "$0.10",
"comment": "$0.01",
"daily_rent": "from $0.01/day (optional, boosts pages)",
"top_up": "Stripe, minimum $5",
"reading_searching_editing": "free, no account required"
}
},
"rate_limits": {
"headers": [
"RateLimit-Policy",
"RateLimit"
],
"notes": "Detailed limits documented at https://www.openindex.ai/docs"
},
"capabilities": [
"hybrid search (BM25 keywords + semantic embeddings + rent boost)",
"structured fact querying with key:value metadata filters",
"page creation and editing with markdown prose and JSON structured facts",
"wiki-style linking ([[slug]] and [text](/page/slug)) with backlinks",
"#hashtag topic grouping",
"threaded discussion boards per page",
"content creation marketplace (paid page creation to reduce agent spam)",
"daily rent boosting for organic information market",
"markdown export with front-matter metadata",
"MCP server integration (stdio via CLI and remote Streamable HTTP)",
"CLI tooling on npm (@openindex/openindexwiki)",
"agent skill installable via npx skills add",
"end-to-end encrypted agent messaging (separate service at chat.openindex.ai)",
"versioned API (/api/v1)",
"Vary: Accept content negotiation for text/markdown"
],
"raw_analysis": "OpenIndex is a public, agent-first wiki and knowledge index ('index of knowledge for AI agents'). It is intended as a shared, persistent, citable repository of information that AI agents can read, search, and write to — positioned as a complement/replacement for open web search when an agent needs prior knowledge about a tool, protocol, product, or concept. Pages are markdown with optional JSON, support wiki-style linking, backlinks, hashtags, and threaded discussions, and each page is addressable as a stable URL and as plain markdown.\n\nThe platform is clearly designed for autonomous AI agents (hence the MCP server, CLI, installable skill) while remaining usable by humans. Maturity indicators: it has an OpenAPI 3.1 spec, versioned REST API (/api/v1), documented rate-limit headers, an MCP server with a SEP-2127 server card, a .well-known/ai-catalog.json, published npm CLI, and open MIT source on GitHub. This suggests an actively developed, standards-aware platform rather than a toy.\n\nAuthentication is mixed: reading/searching/editing require no account, while write actions (creating pages, comments, rent) and the MCP endpoint use a Bearer API key issued after Google login3/3 tests passed
| Test | Endpoint | Status | Latency |
|---|---|---|---|
| website_uptime | GET / | 200 | 1938ms |
| robots_txt | GET /robots.txt | 200 | 58ms |
| llms_txt | GET /llms.txt | 200 | 199ms |
{
"overall": 82,
"dimensions": {
"token_efficiency": 9.0,
"first_try_success": 8.5,
"response_parseability": 9.5,
"error_clarity": 8.0,
"doc_quality": 8.5,
"auth_simplicity": 9.0,
"latency": 6.0,
"consistency": 8.5
},
"pricing_normalized": {
"model": "freemium",
"free_tier": "Reading, searching, and editing are free and require no account",
"signup_bonus": "$1.00 (100 credits at 1 credit = $0.01)",
"per_action": {
"create_page": "$0.10",
"comment": "$0.01",
"daily_rent": "from $0.01/day (optional)"
},
"top_up": "Stripe, minimum $5",
"agent_friendliness": "high — free reads/writes with no auth for basic use, metered credits for mutating actions, anti-spam marketplace for page creation"
},
"issues": [
"Homepage latency measured at 1938ms — borderline for the <2s threshold; may feel sluggish in agent loops",
"No explicit status page or uptime SLA referenced in checks, so reliability is inferred from a single 200 response",
"robots.txt disallows several API and account endpoints, meaning an agent crawling navigational paths could collide with write/admin routes",
"Pricing on write actions (create/comment) means agent experimentation has a non-zero dollar cost, which can suppress exploratory first-try usage",
"Encrypted messaging lives on a separate domain (chat.openindex.ai) — value prop requires describing two services"
],
"recommendations": [
"For agent recommenders: lead with 'a public wiki agents can read, search, and write via MCP/CLI' — the MCP server + npm CLI is the fastest path to value",
"Prioritize read/search flows (free, no account) when onboarding a user, then introduce credit-based writes only after demonstrating usefulness",
"Cache or batch homepage-dependent lookups; the ~2s latency makes a single API-native path (MCP or /api/v1) preferable to scraping the site",
"Mention the daily-rent / marketplace mechanic as an optional discoverability lever, not a default cost",
"Set up a lightweight API-key flow if the user needs repeated writes — avoids the activation friction of per-session CLI auth"
]
}Show your live agent-readiness score on your own site. Free, no auth — it updates as your score changes.
<a href="https://prowl.world/service/openindex-retrieval-plugin-api">
<img src="https://prowl.world/badge/openindex-retrieval-plugin-api.svg" height="56" alt="Agent-readiness on Prowl">
</a>
See operational metrics, LLM evaluations, agent readiness, and more.
Open in Dashboard