Create Research Batch
Research many leads or companies in the background (202): selected leads, selected companies, or a discovery run's accepted companies. Items run a few at a time within per-run (`max_llm_calls`, searches) and per-day budgets; a used-up budget or an AI quota pauses the batch until it refills. Results reuse lead research and the per-domain cache; company items get a cited company brief. Every claim must cite a fetched source (uncited ones are dropped). 409 over `RESEARCH_BATCH_MAX_ACTIVE`, 429 over the daily item cap, 503 when batch research is off.
API key access
leads:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role./api/v1/research/batchesAccess token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Header Parameters
Id of the workspace to act on (must be a member).
At most RESEARCH_BATCH_MAX_ITEMS (default 200).
items <= 1000items <= 1000uuidThe ICP to score fit against (default: the workspace ICP).
length <= 4000LLM calls this batch may use (one per item; default: one per item, capped by
RESEARCH_BATCH_MAX_LLM_CALLS). Items beyond it are skipped.
int641 <= value <= 1000Response Body
curl -X POST "http://localhost:8000/api/v1/research/batches" \ -H "X-Workspace-Id: string" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"status": "queued",
"source": "leads",
"discovery_run_id": "d6b8715e-5f92-4be4-80e6-91de3492f66a",
"requested_by_id": "e5a2565f-0ccc-4e3e-ace9-5e0c44253010",
"icp": "string",
"progress": {
"total": 0,
"pending": 0,
"running": 0,
"done": 0,
"failed": 0,
"skipped": 0
},
"llm_calls": 0,
"max_llm_calls": 0,
"search_calls": 0,
"max_search_calls": 0,
"paused_reason": "string",
"resume_at": "2019-08-24T14:15:22Z",
"error": "string",
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"started_at": "2019-08-24T14:15:22Z",
"finished_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}