Developer API Reference & Sandbox
The OpenSearch Web REST API provides privacy-first, zero-telemetry lexical and hybrid search, instant answers, developer bangs, typo corrections, prefix autocomplete, and cluster health telemetry. OpenSearch Web is an independent software project. It is not affiliated with, funded by, or endorsed by Amazon Web Services, Inc. (AWS) or the Amazon OpenSearch project.
🔍 1. Search Query API
GET
/api/v1/search
Rate Limit: 60 req/min
Executes a lexical BM25 search across the inverted index. Supports quoted phrases, exclusions (
-term), domain filtering (site:), filetype filters, calculations, and 50+ developer bangs (!gh, !npm).
⚡ Live Request Sandbox
💻 Copy-Ready Snippets
curl -X GET "http://localhost:3001/api/v1/search?q=typescript+async+await&limit=5"📦 Real-Time Response
// Click "Execute Request" to test live API response...⚡ 2. Prefix Autocomplete API
GET
/api/v1/suggest
Rate Limit: 60 req/min
Returns instant search-as-you-type completions matching the input prefix from the prefix-trie vocabulary.
⚡ Live Suggest Sandbox
📦 Real-Time Response
// Click "Fetch Suggestions" to test live autocomplete...💓 3. Health & Diagnostics API
GET
/health
Public Diagnostic
Provides real-time health telemetry including document & term counts, memory usage (MB), rate limiter stats, and query cache efficiency.
// Probe cluster health to view system metrics...📋 4. Status Codes & Error Reference
| HTTP Status | Code Name | Description & Resolution |
|---|---|---|
| 200 OK | SUCCESS |
Request succeeded. Returns ranked search results, suggestions, or diagnostic telemetry. |
| 400 Bad Request | VALIDATION_ERROR |
Query parameter missing or out of valid constraints (e.g. empty q or limit > 100). |
| 429 Too Many Requests | RATE_LIMIT_EXCEEDED |
Client IP exceeded the sliding-window rate limit (default: 60 requests / minute). |
| 500 Internal Error | INTERNAL_ERROR |
Server error during index traversal or candidate retrieval. |