Locus Web Research
web_researchGet a grounded, current answer with inline source references: Locus searches the live web, reads sources, and synthesizes the answer. Use when you need an answer, not a list of links; use router/web-search for sources only and router/web-extract to read known URLs. effort light (default, fixed price), medium, or heavy sets depth and cost; maxCredits caps the charge. Always pass effort with maxCredits or search filters, or the call takes the legacy sources-only path and returns no answer. Usually costs ~10.1 credits per call. The result reports credits charged.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | balanced | |
| query | Yes | Search or research request. | |
| rails | No | Legacy access-path field retained for compatible clients. | |
| topic | No | general | |
| _locus | No | Optional Locus execution controls; provider arguments remain top-level. | |
| effort | No | Grounded answer tier. Defaults to light, priced up front. Without effort, maxCredits or search filters such as includeDomains keep the legacy evidence-only contract. | |
| country | No | ||
| strategy | No | Legacy mode selector retained for compatible clients. | |
| providers | No | ||
| maxCredits | No | Aggregate hard charge ceiling in workspace credits. Decimal strings support up to six fractional digits; numeric values are rounded down to six digits. | |
| maxResults | No | ||
| attribution | No | Optional JSON ledger metadata such as a task or customer identifier. | |
| recencyDays | No | ||
| maxProviders | No | ||
| outputSchema | No | Optional bounded JSON object schema for the answer. Requires effort and preserves the same grounded-reference envelope. | |
| includeImages | No | ||
| excludeDomains | No | ||
| externalUserId | No | Optional end-user billing attribution for a tenant secret key. | |
| includeDomains | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | Raw provider response. | |
| usd_charged | No | USD charged (secret-key auth only). | |
| credits_balance | No | ||
| credits_charged | No | ||
| idempotent_replay | No | Stored replay; no new charge. |