Quickstart
Make your first Brime call in under 60 seconds.
1. Get an API key
Create a free account at brime.dev. Free tier ships with 1,000 credits/month — no credit card required.
From your dashboard, click Create API key. Keys start with sk-brime- and are shown once — save them somewhere safe.
export BRIME_API_KEY="sk-brime-..."2. Install the SDK (optional)
pip install brimenpm install @brime-ai/brimeYou can also call the API directly with curl or any HTTP client.
3. First call
from brime import Brime
client = Brime() # uses BRIME_API_KEY
result = client.search(query="Apple Q4 2025 earnings highlights")
print(result.answer)
for r in result.results:
print(f"- {r.title} {r.url}")import { Brime } from "@brime-ai/brime";
const client = new Brime(); // uses BRIME_API_KEY
const result = await client.search({
query: "Apple Q4 2025 earnings highlights",
});
console.log(result.answer);
for (const r of result.results) {
console.log(`- ${r.title} ${r.url}`);
}curl https://api.brime.dev/v1/search \
-H "Authorization: Bearer $BRIME_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query": "Apple Q4 2025 earnings highlights"}'You should get back a JSON object with an answer (a synthesised response) and a results array (the ranked sources). Search is a single instant tier — 0.5 credit per call, ~500 ms p50.
4. Refine with semantic filters
client.search(
query="latest LLM benchmarks",
topic="news", # general | news | finance
time_range="week", # day | week | month | year
domains=["arxiv.org"], # allow-list
)All of topic, time_range, start_date, end_date, domains, exclude_domains are honoured. Cost stays at 0.5 credit per call.
5. Try the other endpoints
Extract
client.extract(urls=["https://example.com"]) — turn any URL into clean markdown.
Research
client.research(query="...") — single tuned multi-round research with citations.
What's next
- Authentication — full key lifecycle, env vars, security.
- Pricing — credit table, plan tiers, free quota.
- SDKs — full reference for Python, Node.js, MCP, LangChain.
- API Reference — live "Try It" playground.