> ## Documentation Index > Fetch the complete documentation index at: https://docs.paywithlocus.com/llms.txt > Use this file to discover all available pages before exploring further. # Preview multi-provider web search > Plans eligible providers and returns the current tenant-aware estimate without calling a provider or burning credits. ## OpenAPI ````yaml /api-reference/openapi.json post /wrapped/credits/router/web-search/preview openapi: 3.1.0 info: title: Locus Pro API description: >- Production is live at https://api.paywithlocus.com/api. Stage remains available for evaluation and integration testing at https://api.stage.paywithlocus.com/api; credentials, balances, and tenant data are isolated by environment. Embedded prepaid credits over the Locus pay-per-use catalog. Money and top-up amounts use exact decimal strings (up to 6dp). Every burn requires an Idempotency-Key header. Management routes accept a tenant secret key or authorized dashboard session as shown per operation. Widget routes accept an end-user JWT alone; when a publishable key is present it must belong to the JWT's tenant. MCP uses OAuth 2.1 Authorization Code with PKCE by default and also accepts the explicitly documented tenant secret key, end-user JWT, or scoped agent connection compatibility credentials. Burns accept the execution credentials shown per operation. Publishable keys never authorize management or burns by themselves. version: 0.6.0 servers: - url: https://api.paywithlocus.com/api description: Production - url: https://api.stage.paywithlocus.com/api description: Stage — evaluation and integration testing security: - secretKey: [] tags: - name: Authentication description: Email-verified self-serve account creation and dashboard identity - name: Tenants description: Tenant profile, keys, and settings (dashboard session or secret key) - name: Workspace members description: Invite-only human workspace membership and role administration - name: Catalog description: Enable/disable APIs and set markups - name: Custom APIs description: >- Available when enabled for the workspace. Enterprise BYOK providers and schema-backed custom actions - name: End users description: End-user accounts, tokens, and allocations - name: Top-ups description: Locus-hosted checkout top-ups and quotes - name: Ledger description: Burn/top-up history and earnings - name: Webhooks description: Signed events, delivery inspection, and replay - name: Burn description: Metered pay-per-use calls - name: Travel routing description: >- Available when enabled for the workspace. Multi-provider flight search, no-dispatch planning, and feedback - name: MCP description: Stateless Streamable HTTP transport and MCP tool-result contracts - name: Okibi Identity description: >- Available when enabled for the workspace. Okibi identity verification and scoped native CLI credential bootstrap - name: Widget description: End-user JWT surface; a matching publishable key is optional - name: Agent-native onboarding description: >- Self-registration, human Stripe funding handoff, and restricted account setup for headless agents - name: Agent connections description: Scoped, expiring, revocable credentials for agent execution - name: Capability routing description: Outcome-level web search and research across eligible catalog providers paths: /wrapped/credits/router/web-search/preview: post: tags: - Capability routing summary: Preview multi-provider web search description: >- Plans eligible providers and returns the current tenant-aware estimate without calling a provider or burning credits. parameters: - $ref: '#/components/parameters/SessionBindingHeader' requestBody: required: true content: application/json: schema: type: object additionalProperties: false required: - query properties: query: type: string minLength: 1 maxLength: 400 mode: type: string enum: - fast - balanced - comprehensive maxResults: type: integer minimum: 1 maximum: 20 default: 10 maxProviders: type: integer minimum: 1 maximum: 13 strategy: type: string enum: - balanced - cost - quality - speed deprecated: true description: Legacy v1 selector. Accepted for compatibility; prefer mode. topic: type: string enum: - general - news recencyDays: type: integer minimum: 1 maximum: 365 country: type: string pattern: ^[A-Za-z]{2}$ includeDomains: type: array maxItems: 20 items: type: string excludeDomains: type: array maxItems: 20 items: type: string includeImages: type: boolean providers: type: array maxItems: 13 items: type: string rails: type: array items: type: string enum: - api-key - mpp - x402 deprecated: true description: >- Legacy v1 payment-path allowlist. Accepted but ignored because Locus chooses each provider payment path internally. maxCredits: oneOf: - $ref: '#/components/schemas/DecimalString' - type: number exclusiveMinimum: 0 deprecated: true externalUserId: type: string attribution: type: object additionalProperties: true responses: '200': description: Free routing plan and current estimate content: application/json: schema: type: object additionalProperties: true '400': $ref: '#/components/responses/BadRequest' '402': description: Insufficient credits '403': description: Capability, provider, policy, or spend limit denied the request '409': description: The aggregate tenant-aware estimate exceeds maxCredits security: - secretKey: [] - endUserToken: [] - agentConnection: [] components: parameters: SessionBindingHeader: name: X-Locus-Session-Id in: header required: false schema: type: string minLength: 16 maxLength: 128 pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{15,127}$ description: >- 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. schemas: DecimalString: type: string pattern: ^\d+(?:\.\d{1,6})?$ description: >- Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply. responses: BadRequest: description: >- The request is malformed or fails local validation before any provider or payment action. securitySchemes: secretKey: type: http scheme: bearer description: Tenant secret key (lcr_…). Server-side only. endUserToken: type: http scheme: bearer description: >- 60-3600 second end-user JWT minted via /credits/end-users/{id}/token. If the JWT has sid, send the original session value in X-Locus-Session-Id; sid contains only its SHA-256 fingerprint. Bearer tokens are replayable until expiry; use short TTLs, optional session binding, and Idempotency-Key on operations. agentConnection: type: http scheme: bearer description: >- Scoped lcac_ credential. Tenant-managed Agent Connections authorize only their bound MCP and wrapped execution surfaces. A bootstrap connection for a self-registered agent additionally authorizes the explicit /credits/agent/* self-service routes for its own account; neither form authorizes general tenant management. ````