Getting Started
Quick Start
This guide will get you from zero to your first API response in under 2 minutes.
Step 1 — Get an API key
Sign up at the dashboard. The Free tier gives you 1,000 requests/month with no credit card required. Your API key will look like: hsx_4626d3fc3fd669...
Store your API key securely. It is shown only once at creation time. If lost, create a new key from the dashboard.
Step 2 — Make a search request
Replace hsx_your_key with your actual API key:
search.sh
curl -X POST https://api.hypersearchx.zuhabul.com/v1/search \
-H "Authorization: Bearer hsx_your_key" \
-H "Content-Type: application/json" \
-d '{"query": "what is tokio in rust", "tier": "summary"}'Step 3 — Understand the response
response.json
{
"meta": {
"query": "what is tokio in rust",
"tier": "summary",
"tokens_used": 1024,
"sources_count": 8,
"duration_ms": 987,
"result_id": "a1b2c3d4-..."
},
"results": [
{
"title": "Tokio — An asynchronous Rust runtime",
"url": "https://tokio.rs",
"snippet": "Tokio is an event-driven, non-blocking I/O platform for writing asynchronous applications with Rust...",
"score": 0.941
}
]
}Key fields:
meta.tokens_used— tokens consumed from your budgetmeta.sources_count— number of sources searched across all backendsresults[].score— HyperFusion neural ranking score (0–1)results[].snippet— token-budgeted extracted content
Step 4 — Try different tiers
The tier parameter controls how much content is extracted:
bash
# Just key facts (~200 tokens) — fast, cheap
curl -X POST .../v1/search -H "Authorization: Bearer hsx_..." \
-d '{"query": "python vs rust performance", "tier": "key_facts"}'
# Detailed analysis (~5,000 tokens) — thorough
curl -X POST .../v1/search -H "Authorization: Bearer hsx_..." \
-d '{"query": "best approaches to async rust", "tier": "detailed"}'Step 5 — Try the research pipeline
The research endpoint runs a full multi-step investigation with citations:
bash
curl -X POST https://api.hypersearchx.zuhabul.com/v1/research \
-H "Authorization: Bearer hsx_your_key" \
-H "Content-Type: application/json" \
-d '{
"query": "Compare vector databases for production use in 2025",
"max_sources": 8,
"citation_style": "apa"
}'