API reference
Research Plan
POST /research/plan · Research
POSThttps://api.clawifi.dev/research/plan5 credits per call
- Send your key as
Authorization: Bearer $CLAWIFI_API_KEY; see Authentication. - Add
"dry_run": true(or?dry_run=true) to see what the call would cost; nothing runs and nothing is charged. - Credits: 5 per call. Every price is on Pricing and credits.
Request#
curl -X POST https://api.clawifi.dev/research/plan \
-H "Authorization: Bearer $CLAWIFI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"what is the Model Context Protocol"}'
from clawifi import Clawifi
client = Clawifi() # reads CLAWIFI_API_KEY
result = client.post("/research/plan", json={"query":"what is the Model Context Protocol"})
Body
| Field | Type | Default | Required |
|---|---|---|---|
allow_browser_fallback | boolean | false | no |
enrich_academic | boolean | false | no |
fetch | boolean | true | no |
formats | array of string (one of 10 values; see Sources) | no | |
lanes | array of "academic" | "code" | "packages" | "web" | no | |
max_items_to_fetch | integer | 3 | no |
max_results_per_source | integer | 5 | no |
query | string | yes | |
sources | array of SourceId | no | |
web_provider | string (one of 15 values; see Sources) | "free_auto" | no |
Response#
200 with a ResearchPlanResponse object: backoff_policy, browser_fallback_allowed, estimated_units, execution_required, free_first_default, free_web_providers, lanes, limits, paid_providers_used, planned_routes, query, recommended_workflow, sources, steps, ….
Errors use the shared shape; see Errors. Try public operations without a key in the playground.
Was this page helpful? Tell us · Last updated 2026-10-22