Research
Get Research Job
A research run queued with `RESEARCH_ASYNC=true` (RO-077): its state, the last error and, once it succeeded, the stored result's id. 404 if the lead is missing or the job is not this lead's research.
API key access
Needs the
leads:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.GET
/api/v1/leads/{lead_id}/research/jobs/{job_id}AuthorizationBearer <token>
Access 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
Path Parameters
lead_idLead Id
Format
uuidjob_idJob Id
Format
uuidHeader Parameters
X-Workspace-Id?X-Workspace-Id
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08/research/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Workspace-Id: string"{
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
"status": "string",
"attempts": 0,
"max_attempts": 0,
"error": "string",
"research_id": "327353d9-c90e-4f59-9fe1-2fde5d36f7ff",
"created_at": "2019-08-24T14:15:22Z",
"finished_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}