planning
research
workflow
tool-selection
reports
x402
category:reports

Research-plan tool selector

LLM-assisted research plan for one goal. Selects and ranks inside the closed Locus catalog; the server joins rail, price, scope, and availability. For choosing the next record call. A deterministic charge-free fallback returns on no key, model failure, or too few valid selections. npx @velinussage/locus-agent-skill add.

post/api/locus-plan-research

Request

  • Base URL: https://api.locus.report
  • URL: https://api.locus.report/api/locus-plan-research
  • Auth: one of:
    • API key in header PAYMENT-SIGNATURE
    • API key in header Authorization

Request body

goalstring

Natural-language research goal. The model selects and ranks only from the closed Locus catalog; it does not author coverage, cost, or availability claims. When omitted, the server synthesizes a goal from intent + place/address.

intentstring

Short research intent (e.g. 'homebuyer', 'renter due diligence', 'small business siting', 'community organizer'). Used to synthesize a goal when goal is omitted.

addressstring

Optional street address. Used for deterministic coverage-profile availability joins and to supply the place when place is omitted.

placestring

Optional ZIP, city, county, or street address used only for deterministic coverage-profile availability joins.

maxSuggestionsinteger

Maximum number of selected tools to return. Defaults to 10 and caps at 15.

Response

Successful paid artifact, or a free pre-charge diagnostic when the request is outside current coverage.

kind'plan_research' required
goalstring required
placestring
chargedboolean required
deterministicFallbackobject required
caveatsstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.