API overview
Live, interactive API playground. Pick an endpoint, set your key, hit Send.
Documentation Index — Fetch the complete documentation index at
/llms.txt. Use that file to discover all available pages before exploring further.
Base URL
https://api.brime.devAuthentication
All Brime endpoints are authenticated with an API key. Pass it as a bearer token:
curl -X POST https://api.brime.dev/v1/search \
-H "Authorization: Bearer sk-brime-..." \
-H "Content-Type: application/json" \
-d '{"query": "Who won the 2025 Champions League final?"}'Get your free key from brime.dev — the free tier ships with 1,000 credits per month with no credit card.
Endpoints
POST /v1/search
Search the web — SERP snippets and a short synthesised answer.
POST /v1/extract
Fetch URLs and return clean markdown.
POST /v1/research
Single tuned multi-round research with citations.
GET /v1/research/{job_id}
Poll an in-flight research job.
GET /v1/research/{job_id}/stream
Server-Sent Events stream of research progress.
Errors
Wire format and the full error code catalog.
Try it from the browser
Every endpoint page has a Try It panel below the schema. Paste your Authorization: Bearer sk-brime-... and run the call live — the request is forwarded through /api/proxy so the browser never hits CORS.
Best practices
For deeper guidance on each endpoint — recommended parameters, edge cases, smart-clean rules, SSE event vocabulary — see Best Practices.
Spec
The full OpenAPI 3.1 spec lives at /openapi.json. Drop it into Postman, Insomnia, or generate clients with openapi-generator.