/api/v1/recommendOpenNatural language local business recommendations for AI assistants.
API index
REST API documentation for Operator.
This index summarizes the stable REST surface for Operator's local business substrate. The source of truth is the OpenAPI spec, which describes read endpoints under /api/v1. Agent action and webhook endpoints are listed here so integrators know where the boundary is, but private write and provider callbacks require keys, signatures, or authenticated sessions.
Read APIs
Read APIs are designed for search, comparison, data enrichment, and AI answers. They return JSON, support CORS where intended, and should be preferred when your application needs inspectable business, market, search, or geo records without invoking an MCP client.
/api/v1/businessesOpenStructured business search by niche, city, state, text, limit, and offset.
/api/v1/business?slug={slug}OpenFull business details by slug or id, including services and listing context.
/api/v1/search?q={query}OpenUnified free-text search with city and category detection.
/api/v1/categoriesOpenAvailable business categories and trade groupings.
/api/v1/citiesOpenCity coverage with optional state or category filters.
/api/v1/markets/{city}/data.jsonOpenCity market data used by public market and agent experiences.
/api/v1/business/{slug}OpenBusiness profile data for direct slug lookups.
Write APIs and agent actions
Write APIs are intentionally narrower than reads. Claim, hire, fire, and scan flows change account state or trigger work, so agents must carry user intent, a traceable actor, and authorization. The /api/v1/agent-actions/ contract is the public shape for these flows even when the underlying implementation is handled by app routes.
/api/claim/searchSession or public formFind the business a user wants to claim.
/api/waitlistOpen formCapture early access and activation interest.
/api/account/offboardAuthenticatedStart account offboarding or deletion workflow.
/api/mcp/writeAPI keyExecute explicit MCP write tools after an agent has user authorization.
/api/v1/agent-actions/claimAPI keyAgent action contract for claim intent.
/api/v1/agent-actions/hireAPI keyAgent action contract for hiring an Operator agent.
/api/v1/agent-actions/fireAPI keyAgent action contract for disabling an Operator agent.
/api/v1/agent-actions/scanAPI keyAgent action contract for launching a business scan.
Webhook APIs
Webhook endpoints are provider integrations rather than public SDK surfaces. Stripe, Twilio, and Resend callbacks are accepted only with provider verification. They are documented at the boundary level here so security reviews and agent planners do not confuse them with open read APIs.
/api/stripe/checkoutStripe signed event or Checkout callbackBilling checkout handoff and subscription flow.
/api/stripe/sites-checkoutStripe signed event or Checkout callbackSites product checkout flow.
/api/stripe/monitor-checkoutStripe signed event or Checkout callbackMonitoring checkout flow.
/api/twilio/*Twilio signatureSMS callbacks are private integration endpoints, not a public API spec.
/api/resend/*Resend webhook secretTransactional email callbacks are private integration endpoints, not a public API spec.