POST /v1/research
Run iterative research with citations — interactive playground.
Cost: 5 credits per call. Errors are not charged. See Pricing.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Header Parameters
Idempotency-Key?string
Required for depth='deep'. SDKs auto-generate per call.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.brime.dev/v1/research" \ -H "Content-Type: application/json" \ -d '{ "query": "what is BM25" }'{
"query": "string",
"answer": "string",
"sources": [
{
"title": "string",
"url": "http://example.com",
"content": "string",
"score": 0,
"published_date": "string"
}
],
"steps": [
{}
],
"request_id": "string",
"credits_used": 0,
"latency_ms": 0
}{
"error": {
"code": "invalid_request",
"message": "query is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid Brime API key."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded. Wait 12 s and retry."
}
}{
"error": {
"code": "upstream_error",
"message": "SERP provider returned 503; retry shortly."
}
}See also: Research best practices · Errors