get_research
Progress and result of a research run. Needs a key.
Needs a keyMCP tool
Parameters
- workspacestringrequired
- runstringrequired
Example call
Agents call tools by name; you rarely write this by hand. It is here so you can test the server from a shell or your own code.
{
"name": "get_research",
"arguments": {
"workspace": "acme-builders",
"run": "8f0c2a4e-1b7d-4c55-9a8e-3d2f6b1c0e91"
}
}Response
The result is one text content block holding this JSON (abbreviated here). Errors come back with isError: true and a message such as Error 401: … or Invalid input: ….
Response
{
"id": "8f0c2a4e-1b7d-4c55-9a8e-3d2f6b1c0e91",
"status": "done",
"website": "https://rival.example",
"pagesRead": 14,
"componentsWritten": 38,
"valuesWritten": 61,
"costUsd": 0.21,
"error": null
}Over REST
The same call without MCP: GET/api/v1/workspaces/:slug/research/:run