Skip to main content
POST
Preview Web Research

Authorizations

Authorization
string
header
required

Tenant secret key (lcr_…). Server-side only.

Headers

X-Locus-Session-Id
string

Required only when the end-user JWT carries sid. Send the original high-entropy session value; sid is its SHA-256 fingerprint. Ignored for secret-key authentication.

Required string length: 16 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{15,127}$

Body

application/json
query
string
required

Search or research request.

Pattern: ^\s*(?:\S|\S[\s\S]{0,398}\S)\s*$
maxResults
integer
default:10
Required range: 1 <= x <= 20
mode
enum<string>
default:balanced
Available options:
fast,
balanced,
comprehensive
maxProviders
integer
default:4
Required range: 1 <= x <= 13
strategy
enum<string>

Legacy mode selector retained for compatible clients.

Available options:
balanced,
cost,
quality,
speed
topic
enum<string>
default:general
Available options:
general,
news
recencyDays
integer
Required range: 1 <= x <= 365
country
string
Pattern: ^[A-Za-z]{2}$
includeDomains
string[]
Maximum array length: 20
Minimum string length: 1
Pattern: \S
excludeDomains
string[]
Maximum array length: 20
Minimum string length: 1
Pattern: \S
includeImages
boolean
default:false
providers
string[]
Maximum array length: 13

Provider ID. Available values: agent402, agentstools, andi, brave, dataforseo, exa, firecrawl, linkup, parallel, perplexity, seltz, serper, tavily. Matching ignores case and surrounding whitespace.

Pattern: ^\s*(?:[aA][gG][eE][nN][tT]402|[aA][gG][eE][nN][tT][sS][tT][oO][oO][lL][sS]|[aA][nN][dD][iI]|[bB][rR][aA][vV][eE]|[dD][aA][tT][aA][fF][oO][rR][sS][eE][oO]|[eE][xX][aA]|[fF][iI][rR][eE][cC][rR][aA][wW][lL]|[lL][iI][nN][kK][uU][pP]|[pP][aA][rR][aA][lL][lL][eE][lL]|[pP][eE][rR][pP][lL][eE][xX][iI][tT][yY]|[sS][eE][lL][tT][zZ]|[sS][eE][rR][pP][eE][rR]|[tT][aA][vV][iI][lL][yY])\s*$
maxCredits

Aggregate hard charge ceiling in workspace credits. Decimal strings support up to six fractional digits; numeric values are rounded down to six digits.

Pattern: ^\s*(?=[0-9.]{1,100}\s*$)0*(?:(?:[1-9]\d{0,11})(?:\.\d{1,6})?|1000000000000(?:\.0{1,6})?|0\.(?=\d{0,5}[1-9])\d{1,6})\s*$
rails
enum<string>[]

Legacy access-path field retained for compatible clients.

Available options:
api-key,
mpp,
x402
externalUserId
string

Optional end-user billing attribution for a tenant secret key.

Minimum string length: 1
Pattern: \S
attribution
object

Optional JSON ledger metadata such as a task or customer identifier.

effort
enum<string>

Explicitly request a grounded answer. Omit only for the legacy evidence-only contract.

Available options:
light,
medium,
heavy
outputSchema
object

Optional bounded JSON object schema for the answer. Requires effort and preserves the same grounded-reference envelope.

Response

Free routing plan and current estimate

The response is of type object.