Research parameters
| Field | Type | Required | Notes |
|---|---|---|---|
query | string | yes | The research question. |
sources | string[] | no | Explicit source filter list. |
limit | number | no | Result count per source. |
depth | quick | default | deep | no | Controls breadth and time budget. |
synthesize | boolean | no | Request a grounded summary. |
subqueries | string[] | no | Override auto-generated query expansion. |
enrich | boolean | no | Read full pages for top-ranked results before synthesis. |
enrich_limit | number | no | Limit the number of enriched results. |
Parameter baseline
```bash
curl https://api.faircompany.ai/v1/crawl/research \
-X POST \
-H "Authorization: Bearer fc_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"query": "Claude Code vs Cursor for large codebases",
"sources": ["web", "reddit", "hackernews", "github"],
"depth": "default",
"synthesize": true
}'
```
```ts
const research = await fc.research({
query: "Claude Code vs Cursor for large codebases",
sources: ["web", "reddit", "hackernews", "github"],
depth: "default",
synthesize: true,
});
console.log(research.synthesis?.summary);
console.log(research.stats);
```
```python
research = fc.research(
"Claude Code vs Cursor for large codebases",
sources=["web", "reddit", "hackernews", "github"],
depth="default",
synthesize=True,
)
print(research.synthesis.summary if research.synthesis else None)
print(research.stats.total_results)
```
```json
{
"tool": "faircrawl_research",
"arguments": {
"query": "Claude Code vs Cursor for large codebases",
"sources": ["web", "reddit", "hackernews", "github"],
"depth": "default",
"synthesize": true
}
}
```